Struct BrowseControllerSynchronousProxy

pub struct BrowseControllerSynchronousProxy { /* private fields */ }

Implementations

impl BrowseControllerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<BrowseControllerEvent, 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_media_player_items( &self, start_index: u32, end_index: u32, ___deadline: MonotonicInstant, ) -> Result<BrowseControllerGetMediaPlayerItemsResult, Error>

Used for GetFolderItems(MediaPlayerList). Gets the list of media players. End index is inclusive.

pub fn get_now_playing_items( &self, start_index: u32, end_index: u32, attribute_option: &AttributeRequestOption, ___deadline: MonotonicInstant, ) -> Result<BrowseControllerGetNowPlayingItemsResult, Error>

Used for GetFolderItems(NowPlayingList). Gets the list of items from the now playing list aka the queue of the addressed media player.

• request end_index is inclusive.

pub fn get_file_system_items( &self, start_index: u32, end_index: u32, attribute_option: &AttributeRequestOption, ___deadline: MonotonicInstant, ) -> Result<BrowseControllerGetFileSystemItemsResult, Error>

Used for GetFolderItems(MediaPlayerVirtualFilesystem). Gets the list of folder item/media element item.

• request end_index is inclusive.

pub fn change_path( &self, path: &Path, ___deadline: MonotonicInstant, ) -> Result<BrowseControllerChangePathResult, Error>

Used for ChangePath browse command.

• request path dictates whether or not the direction will be Move Up or Move down. If path.parent is set, direction will be Move Up. If path.child_folder_uid is set, direction will be Move Down.

pub fn play_file_system_item( &self, uid: u64, ___deadline: MonotonicInstant, ) -> Result<BrowseControllerPlayFileSystemItemResult, Error>

Used for PlayItem(FileSystem).

pub fn play_now_playing_item( &self, uid: u64, ___deadline: MonotonicInstant, ) -> Result<BrowseControllerPlayNowPlayingItemResult, Error>

Used for PlayItem(NowPlayingList). Plays the specified item from the now playing list aka the queue of the addressed media player.

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

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

Trait Implementations

impl Debug for BrowseControllerSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for BrowseControllerSynchronousProxy

type Proxy = BrowseControllerProxy

The async proxy for the same protocol.

type Protocol = BrowseControllerMarker

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.