Struct OpenIpcReceiver 

pub struct OpenIpcReceiver { /* private fields */ }

Browser/WASM receiver for OpenIPC RX transfers and RTP packets.

Implementations

impl OpenIpcReceiver

pub fn new() -> Result<OpenIpcReceiver, JsValue>

Create a plain/FEC-only receiver for the default OpenIPC video channel.

pub fn with_channel_id( channel_id: u32, fec_k: usize, fec_n: usize, ) -> Result<OpenIpcReceiver, JsValue>

Create a plain/FEC-only receiver for a specific channel id.

pub fn with_keypair( channel_id: u32, keypair: &[u8], minimum_epoch: u64, ) -> Result<OpenIpcReceiver, JsValue>

Create an encrypted WFB receiver and default telemetry downlink tap.

pub fn with_keypair_only( channel_id: u32, keypair: &[u8], minimum_epoch: u64, ) -> Result<OpenIpcReceiver, JsValue>

Create an encrypted WFB receiver with only the video route.

pub fn set_rx_descriptor_kind(&mut self, kind: &str) -> Result<(), JsValue>

Select the Realtek USB RX descriptor layout for future bulk-IN transfers.

pub fn with_keypair_and_mavlink_channel( channel_id: u32, mavlink_channel_id: u32, keypair: &[u8], minimum_epoch: u64, ) -> Result<OpenIpcReceiver, JsValue>

Create an encrypted WFB receiver with an explicit raw telemetry channel.

This is the historical JS name. New applications should call withKeypairAndTelemetryChannel.

pub fn with_keypair_and_telemetry_channel( channel_id: u32, telemetry_channel_id: u32, keypair: &[u8], minimum_epoch: u64, ) -> Result<OpenIpcReceiver, JsValue>

Create an encrypted WFB receiver with an explicit raw telemetry channel.

pub fn push_rtp_packet(&mut self, data: &[u8]) -> Option<Uint8Array>

Push one raw RTP packet and return Annex-B bytes when a frame completes.

pub fn push_rtp_packet_detailed( &mut self, data: &[u8], ) -> Result<JsValue, JsValue>

Push one RTP packet and return a typed frame object when one completes.

pub fn push_decrypted_fragment( &mut self, data_nonce_hex: &str, fragment: &[u8], ) -> Result<Array, JsValue>

Push an already-decrypted WFB fragment into the video runtime.

pub fn push_decrypted_80211_frame( &mut self, frame: &[u8], fragment: &[u8], ) -> Result<Array, JsValue>

Push an 802.11 frame with a caller-supplied decrypted WFB fragment.

pub fn push_encrypted_80211_frame( &mut self, frame: &[u8], ) -> Result<Array, JsValue>

Push one encrypted OpenIPC/WFB 802.11 frame.

pub fn push_rx_transfer(&mut self, transfer: &[u8]) -> Result<Array, JsValue>

Push one Realtek RX USB transfer and return completed Annex-B frames.

pub fn push_rx_transfer_detailed( &mut self, transfer: &[u8], ) -> Result<Array, JsValue>

Push one RX transfer and return typed frame objects.

pub fn push_rx_transfer_detailed_with_options( &mut self, transfer: &[u8], keep_corrupted: bool, ) -> Result<Array, JsValue>

Push one RX transfer with control over CRC/ICV-marked packets.

pub fn push_rx_transfer_profiled( &mut self, transfer: &[u8], ) -> Result<Object, JsValue>

Push one RX transfer and return frames plus parser/latency counters.

pub fn push_rx_transfer_profiled_with_options( &mut self, transfer: &[u8], keep_corrupted: bool, ) -> Result<Object, JsValue>

Push one RX transfer with profiling and bad-FCS handling options.

pub fn push_rx_transfer_profiled_with_route_ids( &mut self, transfer: &[u8], keep_corrupted: bool, raw_route_ids: &[u32], ) -> Result<Object, JsValue>

Push one RX transfer and copy raw payloads for caller-selected route IDs.

pub fn push_rx_transfer_profiled_with_route_ids_and_rtp_taps( &mut self, transfer: &[u8], keep_corrupted: bool, raw_route_ids: &[u32], rtp_tap_route_ids: &[u32], rtp_tap_payload_types: &[u8], ) -> Result<Object, JsValue>

Push one RX transfer and copy raw payloads plus filtered RTP payload taps.

pub fn add_keyed_route( &mut self, route_id: u32, channel_id: u32, keypair: &[u8], minimum_epoch: u64, ) -> Result<(), JsValue>

Add an encrypted raw-payload route to the receiver.

pub fn fec_counters(&self) -> String

Return cumulative video FEC counters as JSON.

Trait Implementations

impl From<OpenIpcReceiver> for JsValue

fn from(value: OpenIpcReceiver) -> Self

Converts to this type from the input type.

impl FromWasmAbi for OpenIpcReceiver

type Abi = WasmPtr<WasmRefCell<OpenIpcReceiver>>

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for OpenIpcReceiver

type Abi = WasmPtr<WasmRefCell<OpenIpcReceiver>>

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for OpenIpcReceiver

type Abi = WasmPtr<WasmRefCell<OpenIpcReceiver>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<OpenIpcReceiver>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for OpenIpcReceiver

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for OpenIpcReceiver

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for OpenIpcReceiver

type Abi = WasmPtr<WasmRefCell<OpenIpcReceiver>>

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<OpenIpcReceiver>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for OpenIpcReceiver

type Abi = WasmPtr<WasmRefCell<OpenIpcReceiver>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<OpenIpcReceiver>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl SupportsConstructor for OpenIpcReceiver

impl SupportsInstanceProperty for OpenIpcReceiver

impl SupportsStaticProperty for OpenIpcReceiver

impl TryFromJsValue for OpenIpcReceiver

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for OpenIpcReceiver

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[OpenIpcReceiver]>

impl VectorIntoWasmAbi for OpenIpcReceiver

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[OpenIpcReceiver]>) -> Self::Abi

impl WasmDescribe for OpenIpcReceiver

fn describe()

impl WasmDescribeVector for OpenIpcReceiver

fn describe_vector()