Public Types | Public Member Functions | Private Member Functions | List of all members
MediaStreamAudioDataImportInterface Class Reference

#include <mediasession_stream.h>

Inheritance diagram for MediaStreamAudioDataImportInterface:
Inheritance graph
[legend]

Detailed Description

Stream which represents full image data.

Public Types

using SetAudioDataCallbackType = Delegate< Result< void >(const Block< Char > &)>
 
using InitHandler = Delegate< Result< void >(const MediaStreamAudioDataImportRef &stream, MediaStreamProperties &props)>
 
using SetAudioDataHandler = Delegate< Result< SetAudioDataCallbackType >(const MediaStreamAudioDataImportRef &stream, MediaStreamProperties &props)>
 
using FinishHandler = Delegate< Result< void >(const MediaStreamAudioDataImportRef &stream, const MediaStreamProperties &props)>
 

Public Member Functions

MAXON_METHOD Result< void > SetCallbackHandler (const InitHandler &initHandler, const SetAudioDataHandler &getAudioDataHandler, const FinishHandler &finishHandler)
 
MAXON_METHOD Result< void > InitStream (MediaStreamProperties &props)
 
MAXON_METHOD Result< SetAudioDataCallbackType > SetAudioDataCallback (MediaStreamProperties &props)
 
MAXON_METHOD Result< void > FinishStream (const MediaStreamProperties &props)
 

Private Member Functions

 MAXON_INTERFACE (MediaStreamAudioDataImportInterface, MAXON_REFERENCE_NORMAL, "net.maxon.image.interface.mediastreamaudiodataimport")
 

Member Typedef Documentation

◆ SetAudioDataCallbackType

using SetAudioDataCallbackType = Delegate<Result<void>(const Block<Char>&)>

◆ InitHandler

using InitHandler = Delegate<Result<void>(const MediaStreamAudioDataImportRef& stream, MediaStreamProperties& props)>

◆ SetAudioDataHandler

using SetAudioDataHandler = Delegate<Result<SetAudioDataCallbackType>(const MediaStreamAudioDataImportRef& stream, MediaStreamProperties& props)>

◆ FinishHandler

using FinishHandler = Delegate<Result<void>(const MediaStreamAudioDataImportRef& stream, const MediaStreamProperties& props)>

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( MediaStreamAudioDataImportInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.image.interface.mediastreamaudiodataimport"   
)
private

◆ SetCallbackHandler()

MAXON_METHOD Result<void> SetCallbackHandler ( const InitHandler &  initHandler,
const SetAudioDataHandler &  getAudioDataHandler,
const FinishHandler &  finishHandler 
)

SetCallbackHandler description.

Parameters
[in]initHandlerA handler which is called from the output media converter to signal that data is required for this frame of the stream.
[in]getAudioDataHandlerA handler which is called for each thread that needs a valid SetAudioHandlerDataCallback.
[in]finishHandlerA handler which is called from the output media converter to signal that data writing the data from this stream is finished for this frame of 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.

◆ SetAudioDataCallback()

MAXON_METHOD Result<SetAudioDataCallbackType> SetAudioDataCallback ( MediaStreamProperties &  props)

SetAudioDataCallback description.

Parameters
[in]propsProperties of the audio 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 audio stream.
Returns
OK on success.