pub struct SessionsResource<'a> { /* private fields */ }Expand description
The sessions API. Reached via Client::sessions.
Implementations§
Source§impl<'a> SessionsResource<'a>
impl<'a> SessionsResource<'a>
Sourcepub async fn list(&self, params: SessionListParams) -> Result<Page<Session>>
pub async fn list(&self, params: SessionListParams) -> Result<Page<Session>>
Lists sessions, one page at a time.
Sourcepub fn list_stream(
&self,
params: SessionListParams,
) -> impl Stream<Item = Result<Session>> + Send
pub fn list_stream( &self, params: SessionListParams, ) -> impl Stream<Item = Result<Session>> + Send
Lists sessions, transparently fetching every page.
Sourcepub async fn list_participants(
&self,
session_id: &str,
params: ListParams,
) -> Result<Page<Participant>>
pub async fn list_participants( &self, session_id: &str, params: ListParams, ) -> Result<Page<Participant>>
Lists every participant seen in a session, one page at a time.
Sourcepub async fn list_active_participants(
&self,
session_id: &str,
params: ListParams,
) -> Result<Page<Participant>>
pub async fn list_active_participants( &self, session_id: &str, params: ListParams, ) -> Result<Page<Participant>>
Lists a session’s currently-active participants, one page at a time.
Sourcepub async fn get_participant(
&self,
session_id: &str,
participant_id: &str,
) -> Result<Participant>
pub async fn get_participant( &self, session_id: &str, participant_id: &str, ) -> Result<Participant>
Fetches a single participant within a session.
Sourcepub async fn end(&self, params: SessionEndParams) -> Result<Session>
pub async fn end(&self, params: SessionEndParams) -> Result<Session>
Ends a live session and returns the now-ended session.
Sourcepub async fn remove_participant(
&self,
params: SessionRemoveParticipantParams,
) -> Result<String>
pub async fn remove_participant( &self, params: SessionRemoveParticipantParams, ) -> Result<String>
Removes (kicks) a participant from a live session, returning the server’s confirmation message.
Sourcepub async fn get_stats(&self, session_id: &str) -> Result<QualityStats>
pub async fn get_stats(&self, session_id: &str) -> Result<QualityStats>
Fetches aggregated session-level quality stats.
Sourcepub async fn get_participant_stats(
&self,
session_id: &str,
participant_id: &str,
) -> Result<QualityStats>
pub async fn get_participant_stats( &self, session_id: &str, participant_id: &str, ) -> Result<QualityStats>
Fetches per-participant quality stats, plus resolution usage.
Trait Implementations§
Source§impl<'a> Clone for SessionsResource<'a>
impl<'a> Clone for SessionsResource<'a>
Source§fn clone(&self) -> SessionsResource<'a>
fn clone(&self) -> SessionsResource<'a>
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreimpl<'a> Copy for SessionsResource<'a>
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for SessionsResource<'a>
impl<'a> !UnwindSafe for SessionsResource<'a>
impl<'a> Freeze for SessionsResource<'a>
impl<'a> Send for SessionsResource<'a>
impl<'a> Sync for SessionsResource<'a>
impl<'a> Unpin for SessionsResource<'a>
impl<'a> UnsafeUnpin for SessionsResource<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more