This class is the base class for all live audios. More...

#include <LiveAudio.h>

Inheritance diagram for Ocean::Media::LiveAudio:

Public Types
enum	SampleType : uint32_t { ST_INVALID = 0u , ST_INTEGER_16_MONO_48 , ST_INTEGER_16_STEREO_48 }
	Definition of individual sample types. More...

Public Types inherited from Ocean::Media::Medium
enum	Type : uint32_t { MEDIUM = 0u , FRAME_MEDIUM = 1u << 0u , SOUND_MEDIUM = 1u << 1u , FINITE_MEDIUM = 1u << 2u , LIVE_MEDIUM = 1u << 3u , CONFIG_MEDIUM = 1u << 4u , AUDIO = (1u << 5u) \| FINITE_MEDIUM \| SOUND_MEDIUM , IMAGE = (1u << 6u) \| FRAME_MEDIUM , PIXEL_IMAGE = (1u << 7u) \| FRAME_MEDIUM , BUFFER_IMAGE = (1u << 8u) \| FRAME_MEDIUM , IMAGE_SEQUENCE = (1u << 9u) \| FRAME_MEDIUM \| FINITE_MEDIUM , LIVE_AUDIO = (1u << 10u) \| LIVE_MEDIUM \| SOUND_MEDIUM , LIVE_VIDEO = (1u << 11u) \| LIVE_MEDIUM \| FRAME_MEDIUM , MICROPHONE = (1u << 12u) \| LIVE_MEDIUM , MOVIE = (1u << 13u) \| FINITE_MEDIUM \| FRAME_MEDIUM \| SOUND_MEDIUM }
	Definition of different medium types. More...

Public Types inherited from Ocean::Media::ConfigMedium
using	ConfigNames = std::vector< std::string >
	Definition of a vector holding configuration names.

Public Types inherited from Ocean::Media::SoundMedium
using	SoundFrequency = float
	Definition of a sound frequency defined in Hz.

Public Member Functions
virtual bool	addSamples (const SampleType sampleType, const void *data, const size_t size)
	Adds new samples in case this audio object receives the audio data from a buffer/stream.

virtual bool	needNewSamples () const =0
	Returns whether a new samples needs to be added.

Public Member Functions inherited from Ocean::Media::Medium
const std::string &	url () const
	Returns the url of the medium.

bool	isValid () const
	Returns whether the medium is valid.

const std::string &	library () const
	Returns the name of the owner library.

Type	type () const
	Returns the type of the medium.

bool	isType (const Type type) const
	Returns whether a medium has a given type.

virtual bool	isStarted () const =0
	Returns whether the medium is started currently.

bool	isExclusive () const
	Returns whether this medium can be use exclusively.

virtual bool	start ()=0
	Starts the medium.

virtual bool	pause ()=0
	Pauses the medium.

virtual bool	stop ()=0
	Stops the medium.

virtual Timestamp	startTimestamp () const =0
	Returns the start timestamp.

virtual Timestamp	pauseTimestamp () const =0
	Returns the pause timestamp.

virtual Timestamp	stopTimestamp () const =0
	Returns the stop timestamp.

virtual MediumRef	clone () const
	Clones this medium and returns a new independent instance of this medium.

Public Member Functions inherited from Ocean::Media::ConfigMedium
virtual bool	configuration (const std::string &name, long long data)
	Starts a configuration possibility.

virtual ConfigNames	configs () const
	Returns the names of the configuration possibilities.

Public Member Functions inherited from Ocean::Media::SoundMedium
bool	hasSound () const
	Returns whether the object holds a sound.

unsigned int	soundChannels () const
	Returns the number of sound channels.

SoundFrequency	soundFrequency () const
	Returns the frequency of the sound in Hz.

unsigned int	soundBitsPerSample () const
	Returns the number of bits per sample.

virtual float	soundVolume () const =0
	Returns the volume of the sound in db.

virtual bool	soundMute () const =0
	Returns whether the sound medium is in a mute state.

unsigned int	preferredSoundChannels () const
	Returns the preferred number of sound channels.

SoundFrequency	preferredSoundFrequency () const
	Returns the preferred sound frequency in Hz.

unsigned int	preferredSoundBitsPerSample () const
	Returns the preferred bits per sound sample.

virtual bool	setSoundVolume (const float volume)=0
	Sets the volume of the sound in db.

virtual bool	setSoundMute (const bool mute)=0
	Sets or unsets the sound medium to a mute state.

virtual bool	setPreferredSoundChannels (const unsigned int channels)
	Sets the preferred number of sound channels.

virtual bool	setPreferredSoundFrequency (const SoundFrequency frequency)
	Sets the preferred sound frequency in Hz.

virtual bool	setPreferredSoundBitsPerSample (const unsigned int bits)
	Sets the preferred bits per sound sample.

Static Public Member Functions
static bool	writeWavFile (const std::string &filename, const SampleType sampleType, const void *data, const size_t size)
	Writes a WAV file with given sample data.

Static Public Member Functions inherited from Ocean::Media::Medium
static std::string	convertType (const Type type)
	Converts a medium type to a unique string.

static Type	convertType (const std::string &type)
	Converts a medium type string to a medium type.

Protected Member Functions
	LiveAudio (const std::string &url)
	Creates a new live audio source by a given url.

Protected Member Functions inherited from Ocean::Media::LiveMedium
	LiveMedium (const std::string &url)
	Creates a new live medium by a given url.

Protected Member Functions inherited from Ocean::Media::Medium
	Medium (const Medium &medium)=delete
	Disabled copy constructor.

	Medium (const std::string &url)
	Creates a new medium by a given url.

virtual	~Medium ()
	Destructs a medium.

Medium &	operator= (const Medium &medium)=delete
	Disabled copy operator.

Protected Member Functions inherited from Ocean::Media::ConfigMedium
	ConfigMedium (const std::string &url)
	Creates a new ConfigMedium object by a given url.

Protected Member Functions inherited from Ocean::Media::SoundMedium
	SoundMedium (const std::string &url)
	Creates a new sound medium by a given url.

Additional Inherited Members
Protected Attributes inherited from Ocean::Media::Medium
std::string	url_
	Url of the medium.

std::string	libraryName_
	Name of the owner library.

bool	isValid_ = false
	Determines whether the medium is valid.

Type	type_ = MEDIUM
	Type of the medium.

Lock	lock_
	Medium lock.

Protected Attributes inherited from Ocean::Media::SoundMedium
SoundType	mediumSoundType
	Actual sound type.

SoundType	mediumPreferredSoundType
	Preferred sound type.

Timestamp	mediumSoundTimestamp
	Timestamp of the recent sound frame.

Timestamp	mediumSoundTypeTimestamp
	Timestamp of the recent sound frame type.

Detailed Description

This class is the base class for all live audios.

Member Enumeration Documentation

◆ SampleType

enum Ocean::Media::LiveAudio::SampleType : uint32_t

Definition of individual sample types.

Enumerator
ST_INVALID	An invalid sample type.
ST_INTEGER_16_MONO_48	A sample with 16bit signed integer precision as mono channel and 48kHz.
ST_INTEGER_16_STEREO_48	A sample with 16bit signed integer precision as stereo channel and 48kHz.

Constructor & Destructor Documentation

◆ LiveAudio()

Ocean::Media::LiveAudio::LiveAudio ( const std::string & url )

explicitprotected

Creates a new live audio source by a given url.

Parameters

url	Url of the live audio source

Member Function Documentation

◆ addSamples()

virtual bool Ocean::Media::LiveAudio::addSamples	(	const SampleType	sampleType,
		const void *	data,
		const size_t	size
	)

virtual

Adds new samples in case this audio object receives the audio data from a buffer/stream.

Parameters

sampleType	The type of the samples, must be valid
data	The sample data, must be valid
size	The size of the sample data, in bytes, with range [1, infinity)

Returns: True, if succeeded

Reimplemented in Ocean::Media::Android::ALiveAudio, and Ocean::Media::AVFoundation::AVFLiveAudio.

◆ needNewSamples()

virtual bool Ocean::Media::LiveAudio::needNewSamples ( ) const

pure virtual

Returns whether a new samples needs to be added.

Returns: True, if so

Implemented in Ocean::Media::Android::ALiveAudio, and Ocean::Media::AVFoundation::AVFLiveAudio.

◆ writeWavFile()

static bool Ocean::Media::LiveAudio::writeWavFile	(	const std::string &	filename,
		const SampleType	sampleType,
		const void *	data,
		const size_t	size
	)

static

Writes a WAV file with given sample data.

Parameters

filename	The name of the WAV file to create, must be valid
sampleType	The type of the samples, must be valid
data	The sample data, must be valid
size	The size of the sample data, in bytes, with range [1, infinity)

Returns: True, if succeeded

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

LiveAudio.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SampleType

Constructor & Destructor Documentation

◆ LiveAudio()

Member Function Documentation

◆ addSamples()

◆ needNewSamples()

◆ writeWavFile()