Struct MetadataFrame 

pub struct MetadataFrame { /* private fields */ }

Owned UTF-8 metadata text and its timecode.

NDI expects XML when sending; callers are responsible for XML syntax. Text cannot contain NUL bytes and is limited to 4 MiB including the SDK terminator.

Implementations

impl MetadataFrame

pub fn new() -> Self

Create an empty metadata frame with default SDK timecode behavior.

pub fn with_data(data: impl Into<String>, timecode: i64) -> Result<Self>

Create a metadata frame from UTF-8 text and a timecode.

Errors

Returns Error::InvalidCString if data contains an interior NUL byte or Error::InvalidFrame if the SDK metadata length would exceed the crate’s metadata size limit.

pub fn data(&self) -> &str

Get the metadata text.

pub fn into_data(self) -> String

Consume the frame and return the owned metadata text.

pub fn timecode(&self) -> i64

Get the timecode in 100 ns units.

Defaults to the SDK’s synthesized-timecode sentinel. An explicit zero is passed through as a literal timecode.

pub fn set_data(&mut self, data: impl Into<String>) -> Result<()>

Replace the metadata text.

Errors

Returns Error::InvalidCString if data contains an interior NUL byte or Error::InvalidFrame if the SDK metadata length would exceed the crate’s metadata size limit.

pub fn set_timecode(&mut self, timecode: i64)

Set the timecode.

pub fn with_timecode(self, timecode: i64) -> Self

Return this frame with an updated timecode.

Trait Implementations

impl Clone for MetadataFrame

fn clone(&self) -> MetadataFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataFrame

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

Formats the value using the given formatter.

impl Default for MetadataFrame

fn default() -> Self

Returns the “default value” for a type.