Skip to main content

Crate moq

Crate moq 

Source
Expand description

C bindings for moq_net.

Provides a C-compatible API for real-time pub/sub over QUIC.

§Concepts

  • Session: Network connection to a MoQ relay
  • Origin: Collection of broadcasts
  • Broadcast: Container for tracks
  • Track: Named stream of groups
  • Group: Collection of frames
  • Frame: Sized payload with timestamp

§Error Handling

All functions return negative error codes on failure or non-negative values on success. Resources are managed through opaque integer handles that must be explicitly closed.

Structs§

Audio
Id
Opaque resource identifier returned to C code.
moq_announced
Information about a broadcast announced by an origin.
moq_audio_config
Information about an audio rendition in the catalog.
moq_audio_decoder_output
PCM layout the caller wants out of moq_consume_audio_raw.
moq_audio_encoder_input
PCM layout the caller hands to moq_publish_audio_raw_frame.
moq_audio_encoder_output
Codec-side configuration. sample_rate / channels = 0 means “match the input (snapping the rate up to a libopus-supported value if necessary)”.
moq_audio_frame
One audio frame: payload bytes plus a presentation timestamp.
moq_frame
Information about a frame of media.
moq_video_config
Information about a video rendition in the catalog.

Enums§

Error
Error types that can occur in the FFI layer.
moq_audio_format
Raw PCM sample layout, mirroring WebCodecs AudioData.format.

Functions§

moq_consume_audio_close
Close an audio track consumer and clean up its resources.
moq_consume_audio_config
Query information about an audio track in a catalog.
moq_consume_audio_ordered
Consume an audio track from a broadcast, emitting the frames in order.
moq_consume_audio_raw
Subscribe to an audio track and decode it into PCM.
moq_consume_audio_raw_close
Stop consuming an audio track and cancel its background task.
moq_consume_audio_raw_frame
Copy a delivered frame’s metadata into dst.
moq_consume_audio_raw_frame_free
Free a frame previously delivered through the consume callback. Required for every delivered frame ID; closing the parent consumer is not enough.
moq_consume_catalog
Create a catalog consumer for a broadcast.
moq_consume_catalog_close
Close a catalog consumer and cancel its background task.
moq_consume_catalog_free
Free a catalog snapshot received via the moq_consume_catalog callback.
moq_consume_close
Close a broadcast consumer and clean up its resources.
moq_consume_frame
Get a chunk of a frame’s payload.
moq_consume_frame_close
Close a frame and clean up its resources.
moq_consume_video_close
Close a video track consumer and clean up its resources.
moq_consume_video_config
Query information about a video track in a catalog.
moq_consume_video_ordered
Consume a video track from a broadcast, delivering frames in order.
moq_log_level
Initialize the library with a log level.
moq_origin_announced
Learn about all broadcasts published to an origin.
moq_origin_announced_close
Stop receiving announcements for broadcasts published to an origin.
moq_origin_announced_info
Query information about a broadcast discovered by moq_origin_announced.
moq_origin_close
Close an origin and clean up its resources.
moq_origin_consume
Consume a broadcast from an origin by path.
moq_origin_create
Create an origin for publishing broadcasts.
moq_origin_publish
Publish a broadcast to an origin.
moq_publish_audio_raw
Open an audio track on a broadcast.
moq_publish_audio_raw_close
Flush any pending samples and finalize an audio producer.
moq_publish_audio_raw_frame
Push one audio frame.
moq_publish_close
Close a broadcast and clean up its resources.
moq_publish_create
Create a new broadcast for publishing media tracks.
moq_publish_media_close
Remove a track from a broadcast.
moq_publish_media_frame
Write data to a track.
moq_publish_media_ordered
Create a new media track for a broadcast
moq_session_close
Close a connection to a MoQ server and cancel its background task.
moq_session_connect
Start establishing a connection to a MoQ server.

Type Aliases§

Status
Status code returned by FFI functions.