Struct Play

pub struct Play { /* private fields */ }

The command to tell playing information.

Following format is required:

Field	AMF Type	Value
	Null	Nothing but an AMF’s type marker is in.
Stream Name	String	A name for subscribing a data from the server.
Start Time	Number	Time offset of data subscribing. Note this can be several negative number (See Play Mode).

Play Mode

Value	Play Mode	Description
-2	Both	Subscribes recorded data if its data isn’t on a livestream (default).
-1	Live	Subscribes only as livestream.
0 (And above)	Recorded	Subscribes only as recorded data.

Note the server can treat as some error if its data doesn’t exist as specified mode.

Implementations

impl Play

pub fn new( stream_name: AmfString, start_time: Duration, play_mode: PlayMode, ) -> Self

Constructs a Play command.

pub fn get_stream_name(&self) -> &AmfString

Gets the stream name. (e.g. filename)

pub fn get_start_time(&self) -> Duration

Gets the start time.

pub fn get_play_mode(&self) -> PlayMode

Gets the play mode.

Trait Implementations

impl ChunkData for Play

const CHANNEL: Channel = Channel::Source

const MESSAGE_TYPE: MessageType = MessageType::Command

impl Clone for Play

fn clone(&self) -> Play

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Play

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

Formats the value using the given formatter.

impl Decoder<Play> for ByteBuffer

fn decode(&mut self) -> IOResult<Play>

Decodes bytes into a Play command.

Errors

• InsufficientBufferLength

When some field misses.

• InconsistentMarker

When some value is inconsistent with its marker.

• InvalidString

When some value is invalid for UTF-8 string.

Examples

use sheave_core::{
    ByteBuffer,
    Decoder,
    Encoder,
    messages::{
        Play,
        amf::v0::{
            AmfString,
            Null,
            Number
        }
    }
};

let mut buffer = ByteBuffer::default();
buffer.encode(&Null);
buffer.encode(&AmfString::default());
buffer.encode(&Number::new(-2000f64));
assert!(Decoder::<Play>::decode(&mut buffer).is_ok());

let mut buffer = ByteBuffer::default();
assert!(Decoder::<Play>::decode(&mut buffer).is_err())

impl Encoder<Play> for ByteBuffer

fn encode(&mut self, play: &Play)

Encodes a Play command into bytes.

impl From<Play> for (AmfString, Duration, PlayMode)

fn from(play: Play) -> Self

Converts to this type from the input type.

impl PartialEq for Play

fn eq(&self, other: &Play) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Command for Play

impl StructuralPartialEq for Play