r5::core::Red5Pro Class Reference

Main Red5Pro CoreSDK object This object is used to specify default and common settings for application and create clients for publishing and subscribing. More...

#include <red5pro.h>

Static Public Member Functions
static void	SetLicenseKey (const std::string &licenseKey)
	License key MUST be set before starting any server interaction. More...
static ILoggerPtr	GetDefaultLogger ()
	Get default implementation of ILoggerPtr Default implementation will be used by all objects of SDK if no custom implementation specified. More...
static int	SetDefaultLogger (ILoggerPtr logger)
	Set implementation of ILoggerPtr to use as default. More...
static void	SetDefaultLogLevel (LogLevel level)
	Specify log level for default logger. More...
static void	SetPreferredAudioFormat (AudioFormat fmt)
	Specify audio format that will be used for RTSP connections Note that WebRTC will use only opus encoding regardless of this settings. More...
static ITransformPtr	CreateEncoderForCodec (CodecPtr codec, EncoderSettings set)
	Create in-built encoder implementation for selected codec. More...
static ITransformPtr	CreateDecoderForCodec (CodecPtr codec)
	Create a Decoder For Codec object. More...
static IDemuxingSourcePtr	OpenMediaFile (std::string fname, int numberOfRepeat, ILoggerPtr logger=nullptr)
	Create a source from media file (mp4, mov, etc.) More...
static IClientPtr	CreateClient (const ServerDescription &desc)
	Create a Client object based on provided server description. More...

Detailed Description

Main Red5Pro CoreSDK object This object is used to specify default and common settings for application and create clients for publishing and subscribing.

Member Function Documentation

CreateClient()

static IClientPtr r5::core::Red5Pro::CreateClient ( const ServerDescription &  desc )

static

Create a Client object based on provided server description.

Parameters

desc	description of server connection

Returns

pointer to IClient on success, nullptr on fail

CreateDecoderForCodec()

static ITransformPtr r5::core::Red5Pro::CreateDecoderForCodec ( CodecPtr  codec )

static

Create a Decoder For Codec object.

Parameters

codec

Returns

ITransformPtr

CreateEncoderForCodec()

static ITransformPtr r5::core::Red5Pro::CreateEncoderForCodec ( CodecPtr  codec, EncoderSettings  set  )

static

Create in-built encoder implementation for selected codec.

Parameters

codec	object
set

Returns

ITransformPtr

GetDefaultLogger()

static ILoggerPtr r5::core::Red5Pro::GetDefaultLogger ( )

static

Get default implementation of ILoggerPtr Default implementation will be used by all objects of SDK if no custom implementation specified.

Returns

default implementation of ILoggerPtr

OpenMediaFile()

static IDemuxingSourcePtr r5::core::Red5Pro::OpenMediaFile ( std::string  fname, int  numberOfRepeat, ILoggerPtr  logger = nullptr  )

static

Create a source from media file (mp4, mov, etc.)

Parameters

fname	path to media file
numberOfRepeat	number of times that stream will be repeated after end of file (-1 for constant repeat)
logger	object that implement ILoggerPtr

Returns

ITransformPtr

SetDefaultLogger()

static int r5::core::Red5Pro::SetDefaultLogger ( ILoggerPtr  logger )

static

Set implementation of ILoggerPtr to use as default.

Parameters

logger

object that implement ILoggerPtr

Returns

0 on success, negative on fail

SetDefaultLogLevel()

static void r5::core::Red5Pro::SetDefaultLogLevel ( LogLevel  level )

static

Specify log level for default logger.

Parameters

level

log level to use with default logger

SetLicenseKey()

static void r5::core::Red5Pro::SetLicenseKey ( const std::string &  licenseKey )

static

License key MUST be set before starting any server interaction.

Parameters

licenseKey

string with valid license key

SetPreferredAudioFormat()

static void r5::core::Red5Pro::SetPreferredAudioFormat ( AudioFormat  fmt )

static

Specify audio format that will be used for RTSP connections Note that WebRTC will use only opus encoding regardless of this settings.

Parameters

fmt	format of audio data that will be used for RTSP connection

---

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

• dist/include/r5core/red5pro.h