pj::AudioMediaRecorder Class Reference

#include <media.hpp>

Inheritance diagram for pj::AudioMediaRecorder:

Public Member Functions
	AudioMediaRecorder ()
void	createRecorder (const string &file_name, unsigned enc_type=0, long max_size=0, unsigned options=0) throw (Error)
virtual	~AudioMediaRecorder ()
Public Member Functions inherited from pj::AudioMedia
ConfPortInfo	getPortInfo () const throw (Error)
int	getPortId () const
void	startTransmit (const AudioMedia &sink) const throw (Error)
void	startTransmit2 (const AudioMedia &sink, const AudioMediaTransmitParam &param) const throw (Error)
void	stopTransmit (const AudioMedia &sink) const throw (Error)
void	adjustRxLevel (float level) throw (Error)
void	adjustTxLevel (float level) throw (Error)
unsigned	getRxLevel () const throw (Error)
unsigned	getTxLevel () const throw (Error)
	AudioMedia ()
virtual	~AudioMedia ()
Public Member Functions inherited from pj::Media
virtual	~Media ()
pjmedia_type	getType () const

Static Public Member Functions
static AudioMediaRecorder *	typecastFromAudioMedia (AudioMedia *media)
Static Public Member Functions inherited from pj::AudioMedia
static ConfPortInfo	getPortInfoFromId (int port_id) throw (Error)
static AudioMedia *	typecastFromMedia (Media *media)

Additional Inherited Members
Protected Member Functions inherited from pj::AudioMedia
void	registerMediaPort (MediaPort port) throw (Error)
void	registerMediaPort2 (MediaPort port, pj_pool_t *pool) throw (Error)
void	unregisterMediaPort ()
Protected Member Functions inherited from pj::Media
	Media (pjmedia_type med_type)
Protected Attributes inherited from pj::AudioMedia
int	id

Detailed Description

Audio Media Recorder.

Constructor & Destructor Documentation

AudioMediaRecorder()

pj::AudioMediaRecorder::AudioMediaRecorder

(

)

Constructor.

~AudioMediaRecorder()

virtual pj::AudioMediaRecorder::~AudioMediaRecorder ( )

virtual

Destructor. This will unregister the recorder port from the conference bridge.

Member Function Documentation

createRecorder()

void pj::AudioMediaRecorder::createRecorder	(	const string &	file_name,
		unsigned	enc_type = 0,
		long	max_size = 0,
		unsigned	options = 0
	)
throw	(	Error
	)

Create a file recorder, and automatically connect this recorder to the conference bridge. The recorder currently supports recording WAV file. The type of the recorder to use is determined by the extension of the file (e.g. ".wav").

Parameters

file_name	Output file name. The function will determine the default format to be used based on the file extension. Currently ".wav" is supported on all platforms.
enc_type	Optionally specify the type of encoder to be used to compress the media, if the file can support different encodings. This value must be zero for now.
max_size	Maximum file size. Specify zero or -1 to remove size limitation. This value must be zero or -1 for now.
options	Optional options, which can be used to specify the recording file format. Supported options are PJMEDIA_FILE_WRITE_PCM, PJMEDIA_FILE_WRITE_ALAW, and PJMEDIA_FILE_WRITE_ULAW. Default is zero or PJMEDIA_FILE_WRITE_PCM.

typecastFromAudioMedia()

static AudioMediaRecorder * pj::AudioMediaRecorder::typecastFromAudioMedia ( AudioMedia *  media )

static

Warning: deprecated and will be removed in future release.

Typecast from base class AudioMedia. This is useful for application written in language that does not support downcasting such as Python.

Parameters

media

The object to be downcasted

Returns

The object as AudioMediaRecorder instance

---

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

• media.hpp