traits/speaker.proto

Table of Contents

• traits/speaker.proto

  • DescribeVolumeRequest

  • GetSpeakerVolumeRequest

  • PullSpeakerVolumeRequest

  • PullSpeakerVolumeResponse

  • UpdateSpeakerVolumeRequest

  • VolumeSupport

  • SpeakerApi

  • SpeakerInfo

• Scalar Value Types

Top

traits/speaker.proto

DescribeVolumeRequest

Field	Type	Label	Description
name	string		The name of the device

GetSpeakerVolumeRequest

Field	Type	Label	Description
name	string		Name of the device to fetch the state for
read_mask	google.protobuf.FieldMask		fields to fetch relative the the AudioLevel type

PullSpeakerVolumeRequest

Field	Type	Label	Description
name	string		Name of the device to fetch the state for
read_mask	google.protobuf.FieldMask		fields to fetch relative the the AudioLevel type
updates_only	bool		When true the device will only send changes to the resource value. The default behaviour is to send the current value immediately followed by any updates as they happen.

PullSpeakerVolumeResponse

Field	Type	Label	Description
changes	smartcore.types.AudioLevelChange	repeated	Changes since the last message

UpdateSpeakerVolumeRequest

Field	Type	Label	Description
name	string		Name of the device to update the state for
volume	smartcore.types.AudioLevel		The updated volume value
delta	bool		Only supported for AudioLevel.gain. Update the value relative to the current value.
update_mask	google.protobuf.FieldMask		The fields we intend to update relative to the AudioLevel type

VolumeSupport

VolumeSupport describes the capabilities of devices implementing this trait

Field	Type	Label	Description
resource_support	smartcore.types.ResourceSupport		How a named device supports read/write/pull apis
volume_attributes	smartcore.types.FloatAttributes		Attributes associated with the gain property of the speaker. Note that a step value that is the same as the bounds implies that the speaker only supports mute
mute_support	smartcore.types.MuteSupport		How is mute implemented by the device. Can help to customise behaviour of interfaces to the device, e.g. by disallowing gain change when muted

SpeakerApi

Trait for devices that support some kind of audio output. The most basic is a simple on/off speaker, it's optional to support volume adjustment on a scale.

For the sakes of this trait "volume" means the combination of a gain and a mute state.

Method Name	Request Type	Response Type	Description
GetVolume	GetSpeakerVolumeRequest	.smartcore.types.AudioLevel	Get the current state of the volume for the device
UpdateVolume	UpdateSpeakerVolumeRequest	.smartcore.types.AudioLevel	update the volume state for the device
PullVolume	PullSpeakerVolumeRequest	PullSpeakerVolumeResponse stream

SpeakerInfo

Describes the capabilities of a specific named device with respect to this trait.

Method Name	Request Type	Response Type	Description
DescribeVolume	DescribeVolumeRequest	VolumeSupport	Get information about how a named device implements volume features

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)