Interface used to record audio and video into files. More...

#include <recorder.hh>

Inheritance diagram for linphone::Recorder:

Public Types
enum	State { State::Closed, State::Paused, State::Running }
	Enum representing the state of a recording. More...

Public Member Functions
LINPHONECXX_PUBLIC	Recorder (void *ptr, bool takeRef=true)

LINPHONECXX_PUBLIC _LinphoneRecorder *	cPtr ()

LINPHONECXX_PUBLIC float	getCaptureVolume () const
	Get linear volume when capturing audio. More...

LINPHONECXX_PUBLIC int	getDuration () const
	Gets the duration of the recording. More...

LINPHONECXX_PUBLIC std::string	getFile () const
	Gets the file used for recording. More...

LINPHONECXX_PUBLIC std::shared_ptr< const linphone::RecorderParams >	getParams () const
	Retrieves the RecorderParams object. More...

LINPHONECXX_PUBLIC void	setParams (const std::shared_ptr< linphone::RecorderParams > &params)
	Sets the RecorderParams object. More...

LINPHONECXX_PUBLIC State	getState () const
	Gets the current state of the recorder. More...

LINPHONECXX_PUBLIC void	close ()
	Closes the opened file.

LINPHONECXX_PUBLIC std::shared_ptr< linphone::Content >	createContent ()
	Create a Content object from the recording, for example to send it within a ChatMessage. More...

LINPHONECXX_PUBLIC linphone::Status	open (const std::string &file)
	Opens a file for recording. More...

LINPHONECXX_PUBLIC linphone::Status	pause ()
	Pauses the recording.

LINPHONECXX_PUBLIC linphone::Status	start ()
	Starts the recording into the opened file.

Detailed Description

Interface used to record audio and video into files.

See also: Core::createRecorder()

Member Enumeration Documentation

◆ State

enum linphone::Recorder::State

strong

Enum representing the state of a recording.

Enumerator
Closed	No file is opened for recording.
Paused	The recorder is paused.
Running	The recorder is running.

Member Function Documentation

◆ createContent()

LINPHONECXX_PUBLIC std::shared_ptr<linphone::Content> linphone::Recorder::createContent ( )

Create a Content object from the recording, for example to send it within a ChatMessage.

Warning: Recorder must be in Closed state!

Returns: the Content matching the recording, or nullptr.

◆ getCaptureVolume()

LINPHONECXX_PUBLIC float linphone::Recorder::getCaptureVolume ( ) const

Get linear volume when capturing audio.

Returns: Linear volume.

◆ getDuration()

LINPHONECXX_PUBLIC int linphone::Recorder::getDuration ( ) const

Gets the duration of the recording.

Returns: the duration of the recording, in milliseconds.

◆ getFile()

LINPHONECXX_PUBLIC std::string linphone::Recorder::getFile ( ) const

Gets the file used for recording.

Returns: the file used for the recording if any.

◆ getParams()

LINPHONECXX_PUBLIC std::shared_ptr<const linphone::RecorderParams> linphone::Recorder::getParams ( ) const

Retrieves the RecorderParams object.

Returns: The RecorderParams object.

◆ getState()

LINPHONECXX_PUBLIC State linphone::Recorder::getState ( ) const

Gets the current state of the recorder.

Returns: the current State.

◆ open()

LINPHONECXX_PUBLIC linphone::Status linphone::Recorder::open ( const std::string & file )

Opens a file for recording.

If the file already exists, it will open in append mode, otherwise it is created.

Parameters

file	The path to the file to open.

◆ setParams()

LINPHONECXX_PUBLIC void linphone::Recorder::setParams ( const std::shared_ptr< linphone::RecorderParams > & params )

Sets the RecorderParams object.