#include <source.h>

Inheritance diagram for millicast::AudioPlayback:

[legend]

Collaboration diagram for millicast::AudioPlayback:

[legend]

Classes
struct	Builder
	The Builder struct to build an AudioPlayback. More...

Public Types
using	Ptr = Source::SourcePtr< AudioPlayback >

Public Types inherited from millicast::Source
enum class	Type { DEVICE , MONITOR , APP , MIC , NDI , DECKLINK , TVOS , CUSTOM }
	The Source type. More...

template<typename T >
using	SourcePtr = std::shared_ptr< T >

using	Ptr = SourcePtr< Source >

Public Member Functions
virtual MILLICAST_API void	init_playback ()=0
	Init the playback device.

virtual MILLICAST_API bool	is_playing () const =0
	Tell if the playback device is playing.

Public Member Functions inherited from millicast::Source
template<typename T = Type>
T	type () const
	Get the video source's type.

MILLICAST_API int	id () const
	Get the id of the source.

MILLICAST_API const std::string &	name () const
	Get the name of the source.

MILLICAST_API const std::string &	unique_id () const
	Get the source's unique_id.

MILLICAST_API void	set_track_name (std::string track_name)
	Set the name of the track. The name of the track is the name used to identify the track in the SDP.

MILLICAST_API const std::string &	track_name () const
	Get the name of the track. If you did not set one, it will be the default one.

virtual MILLICAST_API std::weak_ptr< Track >	start_capture ()=0
	Start a capture from this source, this will init and start the capture device and create the corresponding track.

virtual MILLICAST_API void	stop_capture ()=0
	Stop a capture adn release the track and the underlying devices.

virtual MILLICAST_API bool	is_capturing () const =0
	Tell is the source is currently capturing.

virtual MILLICAST_API	~Source ()=default

Public Member Functions inherited from millicast::AudioControl
virtual void	set_volume (uint32_t v)=0
	Set the microphone / speaker volume.

virtual void	set_num_channel (uint8_t n)=0
	Set the number of channels to use.

virtual void	mute (bool m)=0
	Mute the microphone or the speakers.

virtual uint32_t	get_volume ()=0
	Get the current volume.

virtual bool	is_muted () const =0
	Tell whether the mic / speaker is muted or not.

Protected Member Functions
	Source (const SourceInformation &information) noexcept

Protected Member Functions inherited from millicast::Source
	Source (const SourceInformation &information) noexcept

Detailed Description

The AudioPlayback class.

Remarks: This class inherits the Source class, however this is not a capture source. That is why most of the capture interface is overrided in private here.

Member Typedef Documentation

◆ Ptr

using millicast::AudioPlayback::Ptr = Source::SourcePtr<AudioPlayback>

Member Function Documentation

◆ init_playback()

virtual MILLICAST_API void millicast::AudioPlayback::init_playback ( )

pure virtual

Init the playback device.

◆ is_playing()

virtual MILLICAST_API bool millicast::AudioPlayback::is_playing ( ) const

pure virtual

Tell if the playback device is playing.

Returns: true if it is playing, false otherwise

◆ Source()

millicast::Source::Source ( const SourceInformation & information )

protectednoexcept

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

api/millicast-sdk/source.h

Classes

Public Types

Public Member Functions