MediaOutputInterface Class Reference

#include <mediasession_output.h>

Inheritance diagram for MediaOutputInterface:

Detailed Description

The MediaOutputInterface class provides an specific implementation to provide output data to a given destination.

Public Member Functions

MAXON_METHOD Result< void > ResetConverter ()
 
MAXON_METHOD Result< void > SetSelectionHandler (const MediaOutputSelectionHandler &selectionHandler)
 
const MAXON_METHOD MediaOutputSelectionHandlerGetSelectionHandler () const
 
MAXON_METHOD Result< SELECTIONHANDLERRESULTCallSelectionHandler (const MediaStreamRef &stream, const MediaStreamFormat &props)
 

Private Member Functions

 MAXON_INTERFACE (MediaOutputInterface, MAXON_REFERENCE_NORMAL, "net.maxon.image.interface.mediaoutput")
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( MediaOutputInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.image.interface.mediaoutput"   
)
private

◆ ResetConverter()

MAXON_METHOD Result<void> ResetConverter ( )

Resets the converter to default state. This function will be called if the converter is reused and needs to be reinitialized.

Returns
OK on success.

◆ SetSelectionHandler()

MAXON_METHOD Result<void> SetSelectionHandler ( const MediaOutputSelectionHandler selectionHandler)

Sets a selection handler to be called as soon as a new stream is recognized.

Parameters
[in]selectionHandlerHandler to be called.
Returns
OK on success.

◆ GetSelectionHandler()

const MAXON_METHOD MediaOutputSelectionHandler& GetSelectionHandler ( ) const

Sets a selection handler to be called as soon as a new stream is recognized.

Returns
OK on success.

◆ CallSelectionHandler()

MAXON_METHOD Result<SELECTIONHANDLERRESULT> CallSelectionHandler ( const MediaStreamRef &  stream,
const MediaStreamFormat &  props 
)

Called by the input media converter implementation before loading a stream. This function triggers the execution of the MediaOutputSelectionHandler set with SetSelectionHandler.

Parameters
[in]streamStream to check for filtering.
[in]propsProperties of the stream. This can be used to filter for names or special formats etc.
Returns
OK on success.