Ocean::Media::Android::AMedium Class Reference

This class implements the base class for all Medium objects in the Android library. More...

#include <AMedium.h>

Inheritance diagram for Ocean::Media::Android::AMedium:

Data Structures
class	EffectManager
	This manager holds all effects available in the engine. More...

Static Public Member Functions
static bool	areInterfaceIdsIdentical (const SLInterfaceID &interfaceId0, const SLInterfaceID &interfaceId1)
	Returns whether two interface ids are identical.
static std::string	toAString (const SLInterfaceID &interfaceId)
	Returns the hex string of an interface id,.
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.

Static Public Attributes
static constexpr SLInterfaceID_	slEffectTypeNoiseSuppressorId_ = {0x58b4b260, 0x8e06, 0x11e0, 0xaa8e, {0x00, 0x02, 0xa5, 0xd5, 0xc5, 0x1b}}
	Definition of the interface for Noise Suppressor (NS).
static constexpr SLInterfaceID_	slEffectTypeAcousticEchoCancelerId_ = {0x7b491460, 0x8d4d, 0x11e0, 0xbd61, {0x00, 0x02, 0xa5, 0xd5, 0xc5, 0x1b}}
	Definition of the interface for Acoustic Echo Canceler (AEC).

Protected Member Functions
	AMedium (const std::string &url)
	Creates a new 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.

Friends
class	ALibrary

Additional Inherited Members
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 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.
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.

Detailed Description

This class implements the base class for all Medium objects in the Android library.

Constructor & Destructor Documentation

AMedium()

Ocean::Media::Android::AMedium::AMedium ( const std::string &  url )

explicitprotected

Creates a new medium by a given url.

Parameters

url	The URL of the medium

Member Function Documentation

areInterfaceIdsIdentical()

static bool Ocean::Media::Android::AMedium::areInterfaceIdsIdentical ( const SLInterfaceID &  interfaceId0, const SLInterfaceID &  interfaceId1  )

static

Returns whether two interface ids are identical.

Parameters

interfaceId0	The first interface id, must be valid
interfaceId1	The second interface id, must be valid

Returns

True, if so

toAString()

static std::string Ocean::Media::Android::AMedium::toAString ( const SLInterfaceID &  interfaceId )

static

Returns the hex string of an interface id,.

Parameters

interfaceId

The id of the interface

Returns

The resulting string

Friends And Related Symbol Documentation

ALibrary

friend class ALibrary

friend

Field Documentation

slEffectTypeAcousticEchoCancelerId_

constexpr SLInterfaceID_ Ocean::Media::Android::AMedium::slEffectTypeAcousticEchoCancelerId_ = {0x7b491460, 0x8d4d, 0x11e0, 0xbd61, {0x00, 0x02, 0xa5, 0xd5, 0xc5, 0x1b}}

staticconstexpr

Definition of the interface for Acoustic Echo Canceler (AEC).

slEffectTypeNoiseSuppressorId_

constexpr SLInterfaceID_ Ocean::Media::Android::AMedium::slEffectTypeNoiseSuppressorId_ = {0x58b4b260, 0x8e06, 0x11e0, 0xaa8e, {0x00, 0x02, 0xa5, 0xd5, 0xc5, 0x1b}}

staticconstexpr

Definition of the interface for Noise Suppressor (NS).

---

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

• AMedium.h