Struct ndi::send::SendBuilder

pub struct SendBuilder { /* private fields */ }

Builder struct for Send

Implementations

impl SendBuilder

pub fn new() -> Self

Create new builder instance

pub fn ndi_name(self, ndi_name: String) -> Self

This is the name of the NDI source to create.

This will be the name of the NDI source on the network. For instance, if your network machine name is called “MyMachine” and you specify this parameter as “My Video”, the NDI source on the network would be “MyMachine (My Video)”.

pub fn groups(self, groups: String) -> Self

Specify the groups that this NDI sender should place itself into.

Groups are sets of NDI sources. Any source can be part of any number of groups, and groups are comma-separated. For instance “cameras,studio 1,10am show” would place a source in the three groups named.

pub fn clock_video(self, clock_video: bool) -> Self

Specify whether video “clock” themself.

When it is clocked, video frames added will be rate-limited to match the current framerate they are submitted at. In general, if you are submitting video and audio off a single thread you should only clock one of them If you are submitting audio and video of separate threads then having both clocked can be useful. A simplified view of the how works is that, when you submit a frame, it will keep track of the time the next frame would be required at. If you submit a frame before this time, the call will wait until that time. This ensures that, if you sit in a tight loop and render frames as fast as you can go, they will be clocked at the framerate that you desire.

Note that combining clocked video and audio submission combined with asynchronous frame submission (see below) allows you to write very simple loops to render and submit NDI frames.

pub fn clock_audio(self, clock_audio: bool) -> Self

specify whether audio “clock” themself.

See above in clock_video

pub fn build(self) -> Result<Send, SendCreateError>

Build the Send instance

Trait Implementations

impl Clone for SendBuilder

fn clone(&self) -> SendBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendBuilder

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

Formats the value using the given formatter.