Struct roku_ecp::Device

pub struct Device { /* fields omitted */ }

An HTTP client that communicates with a Roku device.

Implementations

impl Device

pub async fn launch<'a>(
    &self,
    app_id: &str,
    parameters: Option<&[(&'a str, &'a str)]>
) -> Result<(), Error>

Launches a channel and passes the parameters given. This call will only launch installed channels.

pub async fn install<'a>(
    &self,
    app_id: &str,
    parameters: Option<&[(&'a str, &'a str)]>
) -> Result<(), Error>

Installs and launches a channel along with passing any given parameters.

impl Device

pub async fn key_press_string(&self, text: &str) -> Result<(), Error>

Sends a key press event for each character in the string.

pub async fn key_down(&self, key: Key) -> Result<(), Error>

Equivalent to pressing the remote control key.

pub async fn key_up(&self, key: Key) -> Result<(), Error>

Equivalent to releasing the remote control key.

pub async fn key_press(&self, key: Key) -> Result<(), Error>

Equivalent to pressing down and releasing the remote control key.

impl Device

pub async fn icon(&self, app_id: &str) -> Result<Icon, Error>

Returns an icon corresponding to the Roku application identified by the app ID.

pub async fn active_app(&self) -> Result<ActiveApp, Error>

Returns information on the currently opened app.

pub async fn apps(&self) -> Result<Vec<App>, Error>

Returns information on all currently installed apps.

impl Device

pub async fn device_info(&self) -> Result<DeviceInfo, Error>

Retrieves device information similar to that returned by roDeviceInfo for BrightScript.

impl Device

pub async fn media_player(&self) -> Result<MediaPlayer, Error>

Information on the current media player state. This includes the current stream segment and position of the content being played, the running time of the content, audio format, and buffering.

impl Device

pub async fn search(&self, search: SearchRequest<'_>) -> Result<(), Error>

Sends a URL query string from the search properties given.

impl Device

pub fn new<T>(ip: T) -> Result<Device, Error> where
    T: ToSocketAddrs + Display, 

Create an HTTP client to communicate with a Roku device. This assumes the device URL is http://ROKU_IP_HERE:8060.

pub fn from_url(url: &str) -> Result<Device, Error>

Creates an HTTP client with a specified URL to communicate with a Roku device. Use this if the default URL (http://ROKU_IP_HERE:8060) is not usable to you.

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

Pings the Roku device to check if the device is online.

Trait Implementations

impl Debug for Device

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

Formats the value using the given formatter.