Click or drag to resize

Microphone Class

Class for capturing audio data with microphone.
Inheritance Hierarchy
SystemObject
  DisposableClass
    AbstractMediaSenderAudioData, AudioFormat
      AudioSender
        Ozeki.MediaMicrophone

Namespace: Ozeki.Media
Assembly: OzekiSDK (in OzekiSDK.dll) Version: 10.4.54.0
Syntax
public class Microphone : AudioSender, IAudioControl, 
	IMedia, IMicrophone, IAudioSender, IMediaSender<AudioData, AudioFormat>

The Microphone type exposes the following members.

Constructors
 NameDescription
Protected methodMicrophone Initializes a new instance of the Microphone class.
Top
Properties
 NameDescription
Public propertyDeviceGUID Gets the GUID of the device which is unique on the Operating System.
Public propertyDeviceInfo Gets the product information of the microphone device.
Public propertyID
(Inherited from DisposableClass)
Public propertyInitialized Returns a boolean value indicating whether the selected microphone device is ready for capturing.
Public propertyLevel Gets the level of the microphone input. (Range: 0-100)
Public propertyMediaFormat Gets the current audio format of the microphone.
Public propertyMuted Gets or sets a boolean value indicating whether the microphone is muted.
Public propertyState Gets the state of the microphone.
Public propertyVolume Gets or sets the volume of the microphone. (Range: 0-1) If the value is -1, the volume of the selected device is fixed and cannot be changed.
Top
Methods
 NameDescription
Public methodChangeFormat Changes the recording format of the device. Please note that this method is not working under linux system due to device driver compatibility issues.
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 methodGetAudioFormat
(Overrides AudioSender.GetAudioFormat)
Public methodStatic memberGetDefaultDevice Retreives the default microphone device
Public methodStatic memberGetDevice Retreives the specified microphone device.
Public methodStatic memberGetDevices Retrieves the available capturing devices.
Public methodStatic memberGetDevicesCount Retreives the number of available capturing devices.
Protected methodReceiverConnected
(Inherited from AudioSender)
Protected methodReceiverDisconnected
(Inherited from AudioSender)
Protected methodSendMediaData
(Inherited from AbstractMediaSenderAudioData, AudioFormat)
Public methodSetPreferredSendFormats
(Inherited from AbstractMediaSenderAudioData, AudioFormat)
Public methodStart Starts microphone audio capture.
Public methodStop Stops microphone audio capture.
Top
Events
 NameDescription
Public eventLevelChanged Occurs when the microphone level has changed.
Public eventMediaDataSent
(Inherited from AbstractMediaSenderAudioData, AudioFormat)
Public eventOnUnplugged Fires when the microphone device is unplugged. It also indicates that this Microphone object has been disposed.
Public eventStopped Occurs when the microphone stopped capturing.
Top
Extension Methods
 NameDescription
Public Extension MethodDisposeManaged Manages access to the microphone's Dispose function. It disposes the microphone 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 microphone's Start function. Use this function paired with StopManaged and DisposeManaged ones.
(Defined by MediaManaged)
Public Extension MethodStopManaged Manages access to the microphone's Stop function. It stops the microphone 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