class Audio::PullAudioInputStream

  • Article 
class Audio::PullAudioInputStream
  : public Audio::AudioInputStream

Pull audio input stream class.

Members

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( void * pvContext , CUSTOM_AUDIO_PULL_STREAM_READ_CALLBACK readCallback , CUSTOM_AUDIO_PULL_STREAM_CLOSE_CALLBACK closeCallback );

Creates a PullAudioInputStream utilizing the specified Read() and Close() "C" callback functions pointers Note: The dataBuffer returned by Read() should not contain any audio header.

Parameters

  • pvContext Context pointer to use when invoking the callbacks.

  • readCallback Read callback.

  • closeCallback Close callback.

Returns

A shared pointer to PullAudioInputStream

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( void * pvContext , CUSTOM_AUDIO_PULL_STREAM_READ_CALLBACK readCallback , CUSTOM_AUDIO_PULL_STREAM_CLOSE_CALLBACK closeCallback , CUSTOM_AUDIO_PULL_STREAM_GET_PROPERTY_CALLBACK getPropertyCallback );

Creates a PullAudioInputStream utilizing the specified Read(), Close() and GetProperty() "C" callback functions pointers Note: The dataBuffer returned by Read() should not contain any audio header. Added in version 1.5.0.

Parameters

  • pvContext Context pointer to use when invoking the callbacks.

  • readCallback Read callback.

  • closeCallback Close callback.

  • getPropertyCallback Get property callback.

Returns

A shared pointer to PullAudioInputStream

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( ReadCallbackFunction_Type readCallback , CloseCallbackFunction_Type closeCallback );

Creates a PullAudioInputStream utilizing the specified Read() and Close() callback functions. Note: The dataBuffer returned by Read() should not contain any audio header.

Parameters

  • readCallback Read callback.

  • closeCallback Close callback.

Returns

A shared pointer to PullAudioInputStream

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( ReadCallbackFunction_Type readCallback , CloseCallbackFunction_Type closeCallback , GetPropertyCallbackFunction_Type getPropertyCallback );

Creates a PullAudioInputStream utilizing the specified Read(), Close() and GetProperty() callback functions. Note: The dataBuffer returned by Read() should not contain any audio header. Added in version 1.5.0.

Parameters

  • readCallback Read callback.

  • closeCallback Close callback.

  • getPropertyCallback Get property callback.

Returns

A shared pointer to PullAudioInputStream

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( std::shared_ptr< PullAudioInputStreamCallback > callback );

Creates a PullAudioInputStream utilizing the specified Close() callback function.

Parameters

  • callback Shared pointer to PullAudioInputStreamCallback instance.

Returns

A shared pointer to PullAudioInputStream

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( std::shared_ptr< AudioStreamFormat > format , void * pvContext , CUSTOM_AUDIO_PULL_STREAM_READ_CALLBACK readCallback , CUSTOM_AUDIO_PULL_STREAM_CLOSE_CALLBACK closeCallback );

Creates a PullAudioInputStream utilizing the specified Read() and Close() "C" callback functions pointers Note: The dataBuffer returned by Read() should not contain any audio header.

Parameters

  • format Audio stream format.

  • pvContext Context pointer to use when invoking the callbacks.

  • readCallback Read callback.

  • closeCallback Close callback.

Returns

A shared pointer to PullAudioInputStream

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( std::shared_ptr< AudioStreamFormat > format , void * pvContext , CUSTOM_AUDIO_PULL_STREAM_READ_CALLBACK readCallback , CUSTOM_AUDIO_PULL_STREAM_CLOSE_CALLBACK closeCallback , CUSTOM_AUDIO_PULL_STREAM_GET_PROPERTY_CALLBACK getPropertyCallback );

Creates a PullAudioInputStream utilizing the specified Read(), Close() and GetProperty() "C" callback functions pointers Note: The dataBuffer returned by Read() should not contain any audio header.

Parameters

  • format Audio stream format.

  • pvContext Context pointer to use when invoking the callbacks.

  • readCallback Read callback.

  • closeCallback Close callback.

  • getPropertyCallback Get property callback.

Returns

A shared pointer to PullAudioInputStream

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( std::shared_ptr< AudioStreamFormat > format , ReadCallbackFunction_Type readCallback , CloseCallbackFunction_Type closeCallback );

Creates a PullAudioInputStream utilizing the specified Read() and Close() callback functions. Note: The dataBuffer returned by Read() should not contain any audio header.

Parameters

  • format Audio stream format.

  • readCallback Read callback.

  • closeCallback Close callback.

Returns

A shared pointer to PullAudioInputStream

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( std::shared_ptr< AudioStreamFormat > format , ReadCallbackFunction_Type readCallback , CloseCallbackFunction_Type closeCallback , GetPropertyCallbackFunction_Type getPropertyCallback );

Creates a PullAudioInputStream utilizing the specified Read(), Close() and GetProperty() callback functions. Note: The dataBuffer returned by Read() should not contain any audio header. Added in version 1.5.0.

Parameters

  • format Audio stream format.

  • readCallback Read callback.

  • closeCallback Close callback.

  • getPropertyCallback Get property callback.

Returns

A shared pointer to PullAudioInputStream

Create

Syntax: public inline static std::shared_ptr< PullAudioInputStream > Create ( std::shared_ptr< AudioStreamFormat > format , std::shared_ptr< PullAudioInputStreamCallback > callback );

Creates a PullAudioInputStream utilizing the specified Read() and Close() callback functions.

Parameters

  • format Audio stream format.

  • callback Shared pointer to PullAudioInputStreamCallback instance.

Returns

A shared pointer to PullAudioInputStream