MediaStreamAudioDataExportInterface Class Reference

#include <mediasession_audiodata.h>

Inheritance diagram for MediaStreamAudioDataExportInterface:

Detailed Description

Stream which represents sound data.

Public Member Functions

MAXON_METHOD Result< void > InitWithAudioData (const AudioObjectRef &audioData)
 
MAXON_METHOD AudioObjectRef GetAudioObject () const
 
MAXON_METHOD Result< void > SetCallbackHandler ()
 
MAXON_METHOD Result< void > InitStream (MediaStreamProperties &props)
 
MAXON_METHOD Result< void > FinishStream (const MediaStreamProperties &props)
 

Private Member Functions

 MAXON_INTERFACE (MediaStreamAudioDataExportInterface, MAXON_REFERENCE_NORMAL, "net.maxon.image.interface.mediastreamaudiodataexport")
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( MediaStreamAudioDataExportInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.image.interface.mediastreamaudiodataexport"   
)
private

◆ InitWithAudioData()

MAXON_METHOD Result<void> InitWithAudioData ( const AudioObjectRef &  audioData)

InitWithAudioData init with a given soundDataRef.

Parameters
[in]audioDataAudio data to set.
Returns
OK on success.

◆ GetAudioObject()

MAXON_METHOD AudioObjectRef GetAudioObject ( ) const

Returns the object given at Init.

Returns
OK on success.

◆ SetCallbackHandler()

MAXON_METHOD Result<void> SetCallbackHandler ( )

Subscribes to the stream.

Returns
OK on success.

◆ InitStream()

MAXON_METHOD Result<void> InitStream ( MediaStreamProperties &  props)

called by the input media converter implementation before loading a stream.

Parameters
[in]propsProperties of the image stream.
Returns
OK on success.

◆ FinishStream()

MAXON_METHOD Result<void> FinishStream ( const MediaStreamProperties &  props)

called by the input media converter implementation when loading the stream is completed.

Parameters
[in]propsProperties of the image stream.
Returns
OK on success.