Struct TestMediaTask

pub struct TestMediaTask {
    pub peer_id: PeerId,
    pub codec_config: MediaCodecConfig,
    pub stream: Arc<Mutex<Option<MediaStream>>>,
    pub delay: Duration,
    /* private fields */
}

Fields

peer_id: PeerId

The PeerId that was used to make this Task

codec_config: MediaCodecConfig

The configuration used to make this task

stream: Arc<Mutex<Option<MediaStream>>>

If still started, this holds the MediaStream.

delay: Duration

Delay the task was started with.

Implementations

impl TestMediaTask

pub fn new( peer_id: PeerId, codec_config: MediaCodecConfig, stream: MediaStream, delay: Duration, ) -> Self

pub fn is_started(&self) -> bool

Return true if the background media task is running.

pub fn end_prematurely(&self, task_result: Option<Result<(), MediaTaskError>>)

End the streaming task without an external stop(). Sends an optional result from the task.

Trait Implementations

impl Clone for TestMediaTask

fn clone(&self) -> TestMediaTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TestMediaTask

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

Formats the value using the given formatter.

impl MediaTask for TestMediaTask

fn finished(&mut self) -> BoxFuture<'static, Result<(), MediaTaskError>>

Returns a Future that finishes when the running media task finshes for any reason. Should return a future that immediately resolves if this task is finished.

fn stop(&mut self) -> Result<(), MediaTaskError>

Stops the task normally, signalling to all waiters Ok(()). Returns the result sent to MediaTask::finished futures, which may be different from Ok(()). When this function returns, is is good practice to ensure the MediaStream that started this task is also dropped.

fn result(&mut self) -> Option<Result<(), MediaTaskError>>

Returns the result if this task has finished, and None otherwise