Struct ndi::recv::Recv [−][src]
pub struct Recv { pub connected: bool, // some fields omitted }
Expand description
The NDI receiver struct
Fields
connected: bool
whether the Recv is currently connected
Implementations
Create new receiver which isn’t connected to any sources
It is recommended that you use RecvBuilder
instead if possible
Disconnect from all sources
Receive video, audio and metadata frames.
This call can be called simultaneously on separate threads,
so it is entirely possible to receive audio, video, metadata all on separate threads.
This function will return FrameType::None
if no data is received within the specified timeout
and FrameType::ErrorFrame
if the connection is lost.
Buffers captured with this must be freed with the appropriate free function.
Receive video frame
Receive audio frame
Receive metadata frame
Get the performance metrics (total, dropped)
Get the current queue sizes
Get the current number of sources connected to
Add a connection metadata string to the list of what is sent on each new connection.
If someone is already connected then this string will be sent to them immediately.
Connection based metadata is data that is sent automatically each time a new connection is received.
To reset them you need to clear them all and set them up again using Recv::recv_clear_connection_metadata()
Send metadata to sender
This returns false
if we are not currently connected to anything.
Clear all connection metadata