conscience_core::media_capture::CscEntityVideoSource Class Reference

#include <CscCaptureEngine.h>

Public Member Functions
bool	equals (ptr< CscEntityVideoSource > other)
	operator string ()
string	toString ()
string	serialize () const
CscJsonObject *	serializeJson () const
const CscEntityVideoSourceType &	getType ()
bool	isNone () const
int	getIntParameter (const string &parameterName)
optional< int >	getOptionalIntParameter (const string &parameterName)
string	getParameter (const string &parameterName)
	CscEntityVideoSource (const CscEntityVideoSourceType &type, const map< string, string > &parameters={})
const string &	getId () const
optional< string >	getNetworkStreamUrl ()
optional< string >	getOptionalParam (const string &parameterName)

Static Public Member Functions
static ptr< CscEntityVideoSource >	none ()
static ptr< CscEntityVideoSource >	localFileStream (const string &footagePath)
static ptr< CscEntityVideoSource >	localDeviceStream (const int &deviceId, const optional< Resolution > &resolution={}, const optional< unsigned > &fps={})
static ptr< CscEntityVideoSource >	networkStream (const string &streamUrl, const optional< Resolution > &resolution={}, const optional< int > &fps={}, const map< string, string > &additionalParams={})
static ptr< CscEntityVideoSource >	fromSerializedJson (CscJsonObjectReader &serialized)
static ptr< CscEntityVideoSource >	fromSerialized (const string &serializedVideoSource)

Constructor & Destructor Documentation

CscEntityVideoSource()

conscience_core::media_capture::CscEntityVideoSource::CscEntityVideoSource	(	const CscEntityVideoSourceType &	type,
		const map< string, string > &	parameters = {}
	)

Member Function Documentation

equals()

bool conscience_core::media_capture::CscEntityVideoSource::equals

(

ptr< CscEntityVideoSource >

other

)

fromSerialized()

ptr< CscEntityVideoSource > conscience_core::media_capture::CscEntityVideoSource::fromSerialized ( const string &  serializedVideoSource )

static

fromSerializedJson()

ptr< CscEntityVideoSource > conscience_core::media_capture::CscEntityVideoSource::fromSerializedJson ( CscJsonObjectReader &  serialized )

static

getId()

const string & conscience_core::media_capture::CscEntityVideoSource::getId

(

)

const

getIntParameter()

int conscience_core::media_capture::CscEntityVideoSource::getIntParameter

(

const string &

parameterName

)

getNetworkStreamUrl()

optional< string > conscience_core::media_capture::CscEntityVideoSource::getNetworkStreamUrl

(

)

Returns

network stream URL - if this source is a network stream - empty otherwise

getOptionalIntParameter()

optional< int > conscience_core::media_capture::CscEntityVideoSource::getOptionalIntParameter

(

const string &

parameterName

)

getOptionalParam()

optional< string > conscience_core::media_capture::CscEntityVideoSource::getOptionalParam

(

const string &

parameterName

)

getParameter()

string conscience_core::media_capture::CscEntityVideoSource::getParameter

(

const string &

parameterName

)

getType()

const CscEntityVideoSourceType & conscience_core::media_capture::CscEntityVideoSource::getType

(

)

isNone()

bool conscience_core::media_capture::CscEntityVideoSource::isNone

(

)

const

localDeviceStream()

ptr< CscEntityVideoSource > conscience_core::media_capture::CscEntityVideoSource::localDeviceStream ( const int &  deviceId, const optional< Resolution > &  resolution = {}, const optional< unsigned > &  fps = {}  )

static

localFileStream()

ptr< CscEntityVideoSource > conscience_core::media_capture::CscEntityVideoSource::localFileStream ( const string &  footagePath )

static

networkStream()

ptr< CscEntityVideoSource > conscience_core::media_capture::CscEntityVideoSource::networkStream ( const string &  streamUrl, const optional< Resolution > &  resolution = {}, const optional< int > &  fps = {}, const map< string, string > &  additionalParams = {}  )

static

Parameters

resolution

a pair: width is the first item, height is the second

none()

ptr< CscEntityVideoSource > conscience_core::media_capture::CscEntityVideoSource::none ( )

static

operator string()

conscience_core::media_capture::CscEntityVideoSource::operator string ( )

inline

serialize()

string conscience_core::media_capture::CscEntityVideoSource::serialize

(

)

const

serializeJson()

CscJsonObject * conscience_core::media_capture::CscEntityVideoSource::serializeJson

(

)

const

toString()

string conscience_core::media_capture::CscEntityVideoSource::toString

(

)

---

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

• CaptureEngine/CscCaptureEngine.h
• CaptureEngine/CscCaptureEngine.cpp