Struct opentok::session::Session

pub struct Session { /* fields omitted */ }

Implementations

impl Session

pub fn new(
    api_key: &str,
    session_id: &str,
    callbacks: SessionCallbacks
) -> Result<Session, OtcError>

Creates a new OpenTok session.

• api_key: Your OpenTok API key. You can get it from https://tokbox.com/account
• session_id: The identifier of the session.
• callbacks: An instance of SessionCallbacks containing the handlers for events related to the session.

pub fn id(&self) -> String

pub fn connect(&self, token: &str) -> OtcResult

Connects a client to an OpenTok session.

• token - The client token for connecting to the session. Check https://tokbox.com/developer/guides/create-token/

pub fn disconnect(&self) -> OtcResult

Disconnects the client from this session. All of the client’s subscribers and publishers will also be disconnected from the session.

pub fn publish(&self, publisher: &Publisher) -> OtcResult

Starts a publisher streaming to the session.

pub fn unpublish(&self, publisher: &Publisher) -> OtcResult

Stops publishing from a session, causing the publisher stream to stop.

pub fn subscribe(&self, subscriber: &Subscriber) -> OtcResult

Starts subscribing to an audio/video stream in this session.

pub fn unsubscribe(&self, subscriber: &Subscriber) -> OtcResult

Stops subscribing to a specific audio/video stream in this session.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for Session

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Session

impl Sync for Session