Struct ControllerSynchronousProxy

pub struct ControllerSynchronousProxy { /* private fields */ }

Implementations

impl ControllerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ControllerEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn get_player_application_settings( &self, attribute_ids: &[PlayerApplicationSettingAttributeId], ___deadline: MonotonicInstant, ) -> Result<ControllerGetPlayerApplicationSettingsResult, Error>

Returns currently set player application setting values for the attribute_ids. If no attribute_ids are provided, this method will query the TG for all valid attribute ID’s, and return the currently set player application setting values.

pub fn set_player_application_settings( &self, requested_settings: &PlayerApplicationSettings, ___deadline: MonotonicInstant, ) -> Result<ControllerSetPlayerApplicationSettingsResult, Error>

Sets the player application settings specified by requested_settings. Only settings specified in the input requested_settings will be overwritten. Returns the actual settings that were set. Settings provided in the requested_settings that are unsupported or unknown will not be set; the returned set_settings will include only the settings that were successfully set on the remote target.

pub fn get_media_attributes( &self, ___deadline: MonotonicInstant, ) -> Result<ControllerGetMediaAttributesResult, Error>

Returns the currently playing media attributes. May send either the GetElementAttributes or GetItemAttributes command depending on what is supported.

pub fn get_play_status( &self, ___deadline: MonotonicInstant, ) -> Result<ControllerGetPlayStatusResult, Error>

Returns the status of the currently playing media.

pub fn set_absolute_volume( &self, requested_volume: u8, ___deadline: MonotonicInstant, ) -> Result<ControllerSetAbsoluteVolumeResult, Error>

Request the absolute volume on the peer be changed. Returns the actual volume set by the peer. Values can range from 0x00 to 0x7F (with 100% volume being 0x7F). You may not get a volume changed notification event from the remote peer as result of changing this.

pub fn inform_battery_status( &self, battery_status: BatteryStatus, ___deadline: MonotonicInstant, ) -> Result<ControllerInformBatteryStatusResult, Error>

Inform target of the controller’s battery level.

pub fn set_notification_filter( &self, notifications: Notifications, position_change_interval: u32, ) -> Result<(), Error>

Filters notifications that will be received with [OnNotification]. Not all notifications are supported by all peers. Resetting the notification filter may trigger all requested notification types to post their current value to [OnNotification] immediately.

The position_change_interval argument is used to set the interval in seconds that the controller client would like to be notified of TRACK_POS_CHANGED events. position_change_interval is ignored if TRACK_POS is not set. The position change interval is best effort and not a guarantee and events may arrive more frequently or less frequently than requested.

pub fn notify_notification_handled(&self) -> Result<(), Error>

Call to acknowledge handling of a notification from [OnNotification].

pub fn set_addressed_player( &self, player_id: u16, ___deadline: MonotonicInstant, ) -> Result<ControllerSetAddressedPlayerResult, Error>

Changes the addressed player_id on the target when multiple are supported.

pub fn send_command( &self, command: AvcPanelCommand, ___deadline: MonotonicInstant, ) -> Result<ControllerSendCommandResult, Error>

Send an AV\C passthrough key command. Sends both a key down and key up event.

Trait Implementations

impl Debug for ControllerSynchronousProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SynchronousProxy for ControllerSynchronousProxy

type Proxy = ControllerProxy

The async proxy for the same protocol.

type Protocol = ControllerMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.