Click or drag to resize

Speaker Class

Class for playing audio through speakers.
Inheritance Hierarchy
SystemObject
  DisposableClass
    AbstractMediaReceiverAudioData, AudioFormat
      AudioReceiver
        Ozeki.MediaSpeaker

Namespace: Ozeki.Media
Assembly: OzekiSDK (in OzekiSDK.dll) Version: 10.4.54.0
Syntax
public class Speaker : AudioReceiver, IAudioControl, 
	IMedia, ISpeaker, IAudioReceiver, IMediaReceiver<AudioData, AudioFormat>

The Speaker type exposes the following members.

Constructors
 NameDescription
Protected methodSpeakerInitializes a new instance of the Speaker class
Top
Properties
 NameDescription
Public propertyConverterType
(Inherited from AudioReceiver)
Public propertyDeviceInfo Gets the product information of the speaker device.
Public propertyID
(Inherited from DisposableClass)
Public propertyInitialized Returns a boolean value indicating whether the selected speaker device is ready.
Public propertyLevel Gets the level of the speaker output. (Range: 0-100)
Public propertyMediaFormat Gets the current audio format of the speaker.
Public propertyMuted Gets or sets a boolean value indicating whether the speaker is muted.
Public propertyReceiveFormats
(Inherited from AbstractMediaReceiverAudioData, AudioFormat)
Public propertyState Gets the state of the playback device.
Public propertyVolume Gets or sets the volume of the speaker. (Range: 0-1)
Top
Methods
 NameDescription
Public methodChangeFormat Changes the playback format of the device.
Public methodDispose
(Inherited from DisposableClass)
Protected methodDispose(Boolean) Disposes the object.
(Overrides DisposableClass.Dispose(Boolean))
Public methodStatic memberDisposeDevices Disposes the previously created and not disposed devices.
Protected methodFinalize
(Inherited from DisposableClass)
Public methodStatic memberGetDefaultDevice Retrieves the default playback device.
Public methodStatic memberGetDefaultDevice(AudioApi) Retrieves the default playback device.
Public methodStatic memberGetDefaultDevice(AudioFormat) Retrieves the default playback device with desired format.
Public methodStatic memberGetDefaultDevice(WaveformParams) Retrieves the default playback device.
Public methodStatic memberGetDevice(AudioDeviceInfo) Retrieves the specified playback device.
Public methodStatic memberGetDevice(AudioDeviceInfo, AudioApi) Retrieves the specified playback device.
Public methodStatic memberGetDevice(AudioDeviceInfo, WaveformParams) Retrieves the specified playback device.
Public methodStatic memberGetDevices Retrieves the available playback devices.
Public methodStatic memberGetDevices(AudioApi) Retrieves the available playback devices.
Public methodStatic memberGetDevicesCount Retrieves the number of available playback devices.
Protected methodOnDataReceived
(Overrides AbstractMediaReceiver.OnDataReceived(Object, UTP))
Protected methodSenderConnected
(Inherited from AudioReceiver)
Protected methodSenderDisconnected
(Inherited from AudioReceiver)
Protected methodSetReceiveFormats
(Inherited from AbstractMediaReceiverAudioData, AudioFormat)
Public methodStart Starts playing the audio from the speaker.
Public methodStop Stops the playing.
Top
Events
 NameDescription
Public eventLevelChanged Occurs when the speaker level has changed.
Public eventReceiveFormatsChanged
(Inherited from AbstractMediaReceiverAudioData, AudioFormat)
Public eventStopped Occurs when the speaker stopped playing.
Top
Extension Methods
 NameDescription
Public Extension MethodDisposeManaged Manages access to the speaker's Dispose function. It disposes the speaker only if all its owners have called DisposeManaged function on it. Use this function paired with StartManaged and StopManaged ones.
(Defined by MediaManaged)
Public Extension MethodStartManaged Manages access to the speaker's Start function. Use this function paired with StopManaged and DisposeManaged ones.
(Defined by MediaManaged)
Public Extension MethodStopManaged Manages access to the speaker's Stop function. It stops the speaker only if all its owners have called StopManaged function on it. Use this function paired with StartManaged and DisposeManaged ones.
(Defined by MediaManaged)
Top
See Also