r5::core::IMediaDescEnumerator Class Reference

Interface to access media type information This interface can be used to enumerate available media types for source devices (e.g. resolution for camera or sample rate for microphone) or transform for codec to define colorspace of number of channels. More...

#include <red5pro.h>

Inheritance diagram for r5::core::IMediaDescEnumerator:

Public Member Functions
virtual int	GetNumberMediaDescs ()=0
	Get the number of default media types Note: depends on actual implementation, but in most cases actual number can be much bigger. More...
virtual int	GetMediaDesc (int idx, MediaTransform &desc)=0
	Get default media type by index. More...
virtual int	GetCurrentMediaDesc (MediaTransform &desc)=0
	Get current media type that is used by object. More...
virtual int	SetCurrentMediaDesc (const MediaTransform &desc)=0
	Set current media type to use by object This method can use output of GetMediaDesc, or custom description. In any case it's better to check return value and GetCurrentMediaDesc after this call. More...

Detailed Description

Interface to access media type information This interface can be used to enumerate available media types for source devices (e.g. resolution for camera or sample rate for microphone) or transform for codec to define colorspace of number of channels.

Member Function Documentation

GetCurrentMediaDesc()

virtual int r5::core::IMediaDescEnumerator::GetCurrentMediaDesc ( MediaTransform &  desc )

pure virtual

Get current media type that is used by object.

Parameters

desc	output media description

Returns

0 on success, negative on fail

GetMediaDesc()

virtual int r5::core::IMediaDescEnumerator::GetMediaDesc ( int  idx, MediaTransform &  desc  )

pure virtual

Get default media type by index.

Parameters

idx	index of media type to get, must be less than GetNumberMediaDescs return
desc	output media description

Returns

0 on success, negative on fail

GetNumberMediaDescs()

virtual int r5::core::IMediaDescEnumerator::GetNumberMediaDescs ( )

pure virtual

Get the number of default media types Note: depends on actual implementation, but in most cases actual number can be much bigger.

See also

SetCurrentMediaDesc

Returns

number of media types available for enumeration

SetCurrentMediaDesc()

virtual int r5::core::IMediaDescEnumerator::SetCurrentMediaDesc ( const MediaTransform &  desc )

pure virtual

Set current media type to use by object This method can use output of GetMediaDesc, or custom description. In any case it's better to check return value and GetCurrentMediaDesc after this call.

Parameters

desc	media description to use by object

Returns

0 on success, negative on fail

---

The documentation for this class was generated from the following file:

• dist/include/r5core/red5pro.h