class Audio::AudioOutputStream

  • Article

Represents audio output stream used for custom audio output configurations. Updated in version 1.7.0.

Members

operator SPXAUDIOSTREAMHANDLE

Syntax: public inline explicit operator SPXAUDIOSTREAMHANDLE ( ) const;

Internal operator used to get underlying handle value.

Returns

A handle.

CreatePullStream

Syntax: public inline static std::shared_ptr< PullAudioOutputStream > CreatePullStream ( );

Creates a memory backed PullAudioOutputStream.

Returns

A shared pointer to PullAudioOutputStream

CreatePushStream

Syntax: public inline static std::shared_ptr< PushAudioOutputStream > CreatePushStream ( void * pvContext , CUSTOM_AUDIO_PUSH_STREAM_WRITE_CALLBACK writeCallback , CUSTOM_AUDIO_PUSH_STREAM_CLOSE_CALLBACK closeCallback );

Creates a PushAudioOutputStream that delegates to the specified callback functions for Write() and Close() methods.

Parameters

  • pvContext Context pointer to use when invoking the callbacks.

  • writeCallback Write callback.

  • closeCallback Close callback.

Returns

A shared pointer to PushAudioOutputStream

CreatePushStream

Syntax: public inline static std::shared_ptr< PushAudioOutputStream > CreatePushStream ( WriteCallbackFunction_Type writeCallback , CloseCallbackFunction_Type closeCallback );

Creates a PushAudioOutputStream that delegates to the specified callback functions for Write() and Close() methods.

Parameters

  • writeCallback Write callback.

  • closeCallback Close callback.

Returns

A shared pointer to PushAudioOutputStream

CreatePushStream

Syntax: public inline static std::shared_ptr< PushAudioOutputStream > CreatePushStream ( std::shared_ptr< PushAudioOutputStreamCallback > callback );

Creates a PushAudioOutputStream that delegates to the specified callback interface for Write() and Close() methods.

Parameters

  • callback Shared pointer to PushAudioOutputStreamCallback instance.

Returns

A shared pointer to PushAudioOutputStream

WriteCallbackFunction_Type

Syntax: typedef WriteCallbackFunction_Type;

CloseCallbackFunction_Type

Syntax: typedef CloseCallbackFunction_Type;