AudioClient Class

AudioClient Class

Core Audio IAudioClient wrapper

Inheritance Hierarchy

Namespace: Ozeki.Media
Assembly: OzekiSDK (in OzekiSDK.dll) Version: 1.8.12.0 (1.8.12)

Syntax

public class AudioClient : IDisposable

Public Class AudioClient
	Implements IDisposable

public ref class AudioClient : IDisposable

type AudioClient =  
    class
        interface IDisposable
    end

The AudioClient type exposes the following members.

Methods

	Name	Description
	Dispose	Releases all resources used by the AudioClient
	Dispose(Boolean)	Releases the unmanaged resources used by the AudioClient and optionally releases the managed resources
	Finalize	(Overrides ObjectFinalize.)
	Initialize	Initializes the audio stream.
	IsFormatSupported	Gets whether the audio endpoint device supports a particular stream format.
	Reset	Resets the audio stream. Requires initialization. Reset is a control method that the client calls to reset a stopped audio stream. Resetting the stream flushes all pending data and resets the audio clock stream position to 0. This method fails if it is called on a stream that is not stopped
	SetEventHandle	Sets the event handle that the audio engine will signal each time a buffer becomes ready to be processed by the client. Requires initialization.
	Start	Starts the audio stream. Requires initialization.
	Stop	Stops the audio stream. Requires initialization.

Properties

	Name	Description
	_audioClientInterface
	BufferSize	Gets the maximum capacity of the audio buffer. Requires initialization.
	CurrentPadding	Gets the number of frames of padding in the endpoint buffer. Requires initialization.
	DefaultDevicePeriod	Gets the length of the default periodic interval separating successive processing passes by the audio engine on the data in the endpoint buffer.
	Initialized
	MinimumDevicePeriod	Gets the length of the minimum periodic interval separating successive processing passes by the audio engine on the data in the endpoint buffer.
	MixFormat	Gets the stream format that the audio engine uses for its internal processing of shared-mode streams. Requires initialization.
	StreamLatency	Gets the maximum latency for the current stream. Requires initialization.