opentera::VideoStreamConfiguration Class Reference

Represents a video stream configuration. More...

#include <VideoStreamConfiguration.h>

Public Member Functions
	VideoStreamConfiguration (const VideoStreamConfiguration &other)=default
	VideoStreamConfiguration (VideoStreamConfiguration &&other)=default
const std::unordered_set< VideoStreamCodec > &	forcedCodecs () const
	Returns the codecs that must be used. An empty set means all codecs. More...
bool	forceGStreamerHardwareAcceleration () const
	Indicates that hardware accelerated codecs must be used. More...
bool	useGStreamerSoftwareEncoderDecoder () const
	Indicates to use GStreamer software codecs instead of WebRTC ones. More...
VideoStreamConfiguration &	operator= (const VideoStreamConfiguration &other)=default
VideoStreamConfiguration &	operator= (VideoStreamConfiguration &&other)=default

Static Public Member Functions
static VideoStreamConfiguration	create ()
	Creates a stream configuration with default values. More...
static VideoStreamConfiguration	create (std::unordered_set< VideoStreamCodec > forcedCodecs)
	Creates a video stream configuration with the specified value. More...
static VideoStreamConfiguration	create (std::unordered_set< VideoStreamCodec > forcedCodecs, bool forceGStreamerHardwareAcceleration, bool useGStreamerSoftwareEncoderDecoder)
	Creates a video stream configuration with the specified values. More...

Detailed Description

Represents a video stream configuration.

Member Function Documentation

create() [1/3]

VideoStreamConfiguration opentera::VideoStreamConfiguration::create ( )

inlinestatic

Creates a stream configuration with default values.

Returns

A stream configuration with default values

create() [2/3]

VideoStreamConfiguration opentera::VideoStreamConfiguration::create ( std::unordered_set< VideoStreamCodec >  forcedCodecs )

inlinestatic

Creates a video stream configuration with the specified value.

Parameters

forcedCodecs

Indicates the codecs that must be used. An empty set means all codecs.

Returns

A video stream configuration with the specified value

create() [3/3]

VideoStreamConfiguration opentera::VideoStreamConfiguration::create ( std::unordered_set< VideoStreamCodec >  forcedCodecs, bool  forceGStreamerHardwareAcceleration, bool  useGStreamerSoftwareEncoderDecoder  )

inlinestatic

Creates a video stream configuration with the specified values.

Parameters

forcedCodecs	Indicates the codecs that must be used. An empty set means all codecs.
forceGStreamerHardwareAcceleration	Indicates that hardware accelerated codecs must be used. It has no effect when the library is not built with GStreamer.
useGStreamerSoftwareEncoderDecoder	Indicates to use GStreamer software codecs instead of WebRTC ones. It has no effect when the library is not built with GStreamer.

Returns

A video stream channel configuration with the specified values

forcedCodecs()

const std::unordered_set< VideoStreamCodec > & opentera::VideoStreamConfiguration::forcedCodecs ( ) const

inline

Returns the codecs that must be used. An empty set means all codecs.

Returns

The codecs that must be used

forceGStreamerHardwareAcceleration()

bool opentera::VideoStreamConfiguration::forceGStreamerHardwareAcceleration ( ) const

inline

Indicates that hardware accelerated codecs must be used.

Returns

true if only hardware accelerated codecs can be used.

useGStreamerSoftwareEncoderDecoder()

bool opentera::VideoStreamConfiguration::useGStreamerSoftwareEncoderDecoder ( ) const

inline

Indicates to use GStreamer software codecs instead of WebRTC ones.

Returns

true if GStreamer software codecs must be used instead of WebRTC ones.

---

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

• VideoStreamConfiguration.h
• VideoStreamConfiguration.cpp