Struct FrameCaptureRequest 

pub struct FrameCaptureRequest {
    pub streamer_id: String,
    pub capture_id: String,
    pub command_id: String,
    pub capture_context: StoredCaptureContext,
    pub target: FrameCaptureTarget,
    pub force: bool,
    pub requested_at_ms: u64,
    pub id: FrameCaptureRequestId,
}

One operator request for a synchronized nDisplay frame capture.

The browser NEVER talks to Pulse Cluster. This entity is the whole client-facing surface: the UI writes typed editorial context plus a typed target selection, and an off-browser bridge (holding the cluster credential) submits it and mirrors authoritative status back as [FrameCaptureStatus]. Keyed by streamer id — one in-flight capture per stream, mirroring RecordingJobRequest.

Fields

streamer_id: String

capture_id: String

Stable id for this capture across submit/status/receipt. Client-minted (UUIDv7) so retries of the same intent are idempotent at the bridge.

command_id: String

Makes a re-submitted command idempotent, like RecordingJobRequest.

capture_context: StoredCaptureContext

Frozen editorial identity: typed collection ref, optional label, optional content revision. Required — capture output is filed by editorial context, and the collection must be explicit, never inferred.

target: FrameCaptureTarget

Typed target selection. The UI picks from the summaries the bridge mirrors; it never constructs cluster addresses.

force: bool

Explicit operator override. Cluster’s force submits despite missing or stalled frame-progress telemetry ONLY; exact target identity, generation, revision, and capture capability remain required. Never set automatically — the operator asks for it after a refusal.

requested_at_ms: u64

id: FrameCaptureRequestId

Trait Implementations

impl AnyItem for FrameCaptureRequest

fn as_any(&self) -> &dyn Any

Returns self as &dyn Any for downcasting.

fn entity_type(&self) -> &'static str

Returns the entity type name (e.g., “Target”, “Scene”).

fn equals(&self, other: &dyn AnyItem) -> bool

Typed equality across erased items.

fn server_owner(&self) -> Option<&str>

Returns the current #[server_owned] field value, if this item has one.

fn bake_server_owner(&self, server_id: &str) -> Option<Arc<dyn AnyItem>>

Returns a clone of this item with the #[server_owned] field set to server_id. Returns None if this item has no #[server_owned] field.

impl Clone for FrameCaptureRequest

fn clone(&self) -> FrameCaptureRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameCaptureRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrameCaptureRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eventable for FrameCaptureRequest

const ENTITY_NAME_STATIC: &'static str = "FrameCaptureRequest"

Static entity type name (use entity_type() from AnyItem for instance access).

fn entity_name_static() -> &'static str

Back-compat helper for generic call sites that still expect a function.

fn ingest_buffer_policy() -> IngestBufferPolicy

Opt-in ingest buffering policy for this entity type.

fn parse(value: Value) -> Result<Arc<dyn AnyItem>, Error>

Parse JSON into this item type.

fn parse_bytes(bytes: &[u8]) -> Result<Arc<dyn AnyItem>, Error>

Parse JSON bytes into this item type. Skips the Value round-trip when callers can hand off raw bytes (~2.27× faster than the Value → from_value path on a typical entity payload).

impl IdFor<FrameCaptureRequest> for FrameCaptureRequestId

type MapKey = Arc<str>

fn map_key(&self) -> Self::MapKey

impl PartialEq for FrameCaptureRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FrameCaptureRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for FrameCaptureRequest

type WithoutGenerics = FrameCaptureRequest

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = FrameCaptureRequest

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.

impl WithId for FrameCaptureRequest

fn id(&self) -> Arc<str>

impl WithTypedId for FrameCaptureRequest

type Id = FrameCaptureRequestId

fn typed_id(&self) -> Self::Id