MediaSessionInterface Class Reference

#include <mediasession_session.h>

Inheritance diagram for MediaSessionInterface:

Detailed Description

The media session interface connects media inputs with media outputs. For each output a MediaConnectionRef is handled. @MAXON_ANNOTATION{nullimpl=true}

Public Member Functions

MAXON_METHOD Result< void > ConnectMediaConverter (const MediaConverterRef &input, const MediaConverterRef &output)
 
MAXON_METHOD Result< void > Convert (const TimeValue &targetTime, MEDIASESSIONFLAGS flags)
 
MAXON_METHOD Result< void > Close ()
 
MAXON_METHOD MediaSessionProgressRef GetProgress () const
 

Private Member Functions

 MAXON_INTERFACE (MediaSessionInterface, MAXON_REFERENCE_NORMAL, "net.maxon.image.interface.mediasession")
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( MediaSessionInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.image.interface.mediasession"   
)
private

◆ ConnectMediaConverter()

MAXON_METHOD Result<void> ConnectMediaConverter ( const MediaConverterRef &  input,
const MediaConverterRef &  output 
)

Connects two MediaConverterRefs within a Media Session. Both converters must not be attached to another session.

◆ Convert()

MAXON_METHOD Result<void> Convert ( const TimeValue targetTime,
MEDIASESSIONFLAGS  flags 
)

Triggers the session to read the next frame from the stream.

Parameters
[in]targetTimeTarget time to receive the media samples from.
[in]flagsSee MEDIASESSIONFLAGS for details.

◆ Close()

MAXON_METHOD Result<void> Close ( )

Closes the session, finalizes all write operations and closes all handles.

◆ GetProgress()

MAXON_METHOD MediaSessionProgressRef GetProgress ( ) const

Returns the progress object to set/get progress for implementors.