viam::sdk::impl::AudioOutClient Class Reference

gRPC client implementation of an AudioOut component. More...

#include <audio_out_client.hpp>

Inheritance diagram for viam::sdk::impl::AudioOutClient:

Public Types
using	interface_type = AudioOut
Public Types inherited from viam::sdk::AudioOut
using	audio_info = viam::sdk::audio_info

Public Member Functions
	AudioOutClient (std::string name, std::shared_ptr< grpc::Channel > channel)
void	play (std::vector< uint8_t > const &audio_data, boost::optional< audio_info > info, const ProtoStruct &extra) override
	Play audio through the audioout component.
audio_properties	get_properties (const ProtoStruct &extra) override
	Returns properties of the audio out device (supported codecs, sample rate, number of channels)
ProtoStruct	do_command (const ProtoStruct &command) override
	Send/receive arbitrary commands to the resource.
std::vector< GeometryConfig >	get_geometries (const ProtoStruct &extra) override
	Returns GeometryConfigs associated with the calling audioout.
std::vector< GeometryConfig >	get_geometries ()
virtual std::vector< GeometryConfig >	get_geometries (const ProtoStruct &extra)=0
	Returns GeometryConfigs associated with the calling audioout.
audio_properties	get_properties ()
	Returns properties of the audio out device (supported codecs, sample rate, number of channels)
virtual audio_properties	get_properties (const ProtoStruct &extra)=0
	Returns properties of the audio out device (supported codecs, sample rate, number of channels)
void	play (std::vector< uint8_t > const &audio_data, boost::optional< audio_info > info)
	Play audio data.
virtual void	play (std::vector< uint8_t > const &audio_data, boost::optional< audio_info > info, const ProtoStruct &extra)=0
	Play audio through the audioout component.
Public Member Functions inherited from viam::sdk::AudioOut
void	play (std::vector< uint8_t > const &audio_data, boost::optional< audio_info > info)
	Play audio data.
audio_properties	get_properties ()
	Returns properties of the audio out device (supported codecs, sample rate, number of channels)
std::vector< GeometryConfig >	get_geometries ()
API	api () const override
	Returns the API associated with a particular resource.
Public Member Functions inherited from viam::sdk::Component
Name	get_resource_name () const override
	Returns the Name for a particular resource.
Public Member Functions inherited from viam::sdk::Resource
	Resource (std::string name)
virtual std::string	name () const
	Return the resource's name.
void	set_log_level (log_level) const
	Set the log level for log messages originating from this Resource.

Additional Inherited Members
Protected Member Functions inherited from viam::sdk::AudioOut
	AudioOut (std::string name)
Protected Member Functions inherited from viam::sdk::Component
	Component (std::string name)
Protected Member Functions inherited from viam::sdk::Resource
Name	get_resource_name (const std::string &type) const
Protected Attributes inherited from viam::sdk::Resource
LogSource	logger_

Detailed Description

gRPC client implementation of an AudioOut component.

Member Function Documentation

do_command()

ProtoStruct viam::sdk::impl::AudioOutClient::do_command ( const ProtoStruct & command )

overridevirtual

Send/receive arbitrary commands to the resource.

Parameters

command

the command to execute.

Returns

The result of the executed command.

Implements viam::sdk::AudioOut.

get_geometries() [1/3]

std::vector< GeometryConfig > viam::sdk::AudioOut::get_geometries ( )

inline

Returns

The requested GeometryConfigs associated with the component.

get_geometries() [2/3]

std::vector< GeometryConfig > viam::sdk::impl::AudioOutClient::get_geometries ( const ProtoStruct & extra )

overridevirtual

Returns GeometryConfigs associated with the calling audioout.

Parameters

extra

Any additional arguments to the method.

Returns

The requested GeometryConfigs associated with the component.

Implements viam::sdk::AudioOut.

get_geometries() [3/3]

virtual std::vector< GeometryConfig > viam::sdk::AudioOut::get_geometries ( const ProtoStruct & extra )

virtual

Returns GeometryConfigs associated with the calling audioout.

Parameters

extra

Any additional arguments to the method.

Returns

The requested GeometryConfigs associated with the component.

Implements viam::sdk::AudioOut.

get_properties() [1/2]

audio_properties viam::sdk::impl::AudioOutClient::get_properties ( const ProtoStruct & extra )

overridevirtual

Returns properties of the audio out device (supported codecs, sample rate, number of channels)

Parameters

extra

Any additional arguments to the method

Implements viam::sdk::AudioOut.

get_properties() [2/2]

virtual audio_properties viam::sdk::AudioOut::get_properties ( const ProtoStruct & extra )

virtual

Returns properties of the audio out device (supported codecs, sample rate, number of channels)

Parameters

extra

Any additional arguments to the method

Implements viam::sdk::AudioOut.

play() [1/3]

void viam::sdk::AudioOut::play ( std::vector< uint8_t > const & audio_data, boost::optional< audio_info > info )

inline

Play audio data.

Parameters

audio_data	The audio data to play as bytes
info	Optional info about the audio_data (codec, sample rate, channels). Required for raw PCM data.

play() [2/3]

void viam::sdk::impl::AudioOutClient::play ( std::vector< uint8_t > const & audio_data, boost::optional< audio_info > info, const ProtoStruct & extra )

overridevirtual

Play audio through the audioout component.

Parameters

audio_data	The audio data to play
info	Optional info about the audio_data (codec, sample rate, channels). Required for raw PCM data.
extra	Any additional arguments to the method

Implements viam::sdk::AudioOut.

play() [3/3]

virtual void viam::sdk::AudioOut::play ( std::vector< uint8_t > const & audio_data, boost::optional< audio_info > info, const ProtoStruct & extra )

virtual

Play audio through the audioout component.

Parameters

audio_data	The audio data to play
info	Optional info about the audio_data (codec, sample rate, channels). Required for raw PCM data.
extra	Any additional arguments to the method

Implements viam::sdk::AudioOut.

---

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

• src/viam/sdk/components/private/audio_out_client.hpp