Struct Cast 

pub struct Cast {
    pub stream_id: u64,
    pub session_id: u64,
    pub kind: CastKind,
    pub target: CastTarget,
    pub is_dynamic_target: bool,
    pub is_active: bool,
    pub pid: Option<i32>,
    pub pw_node_id: Option<u32>,
}

A screencast.

Fields

stream_id: u64

Stream ID of the screencast that uniquely identifies it.

session_id: u64

Session ID of the screencast.

A session can have multiple screencast streams. Then multiple Casts will have the same session_id. Though, usually there’s only one stream per session.

Do not confuse session_id with stream_id.

kind: CastKind

Kind of this screencast.

target: CastTarget

Target being captured.

is_dynamic_target: bool

Whether this is a Dynamic Cast Target screencast.

Meaning that actions like SetDynamicCastWindow will act on this screencast.

Keep in mind that the target can change even if this is false.

is_active: bool

Whether the cast is currently streaming frames.

This can be false for example when switching away to a different scene in OBS, which pauses the stream.

pid: Option<i32>

Process ID of the screencast consumer, if known.

Currently, only wlr-screencopy screencasts can have a pid.

pw_node_id: Option<u32>

PipeWire node ID of the screencast stream.

This is None for wlr-screencopy casts, and also for PipeWire casts before the node is created (when the cast is just starting up).

Trait Implementations

impl Clone for Cast

fn clone(&self) -> Cast

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cast

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cast

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Cast

fn eq(&self, other: &Cast) -> 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 Serialize for Cast

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Cast

impl StructuralPartialEq for Cast