Graft host pipeline C surface

Graft host pipeline C surface

Narrow host-exported C ABI for the first Rust-facing pipeline surface.

Classes

NameDescription
icy_pipeline_optionsOptions for icy_pipeline_api.create: the pipeline's name, signalling token, room and ICE server, with struct_size set to the size the caller was built with.
icy_pipeline_apiThe pipeline host API returned by icy_pipeline_api(): create a pipeline, attach an RTSP source and a WebRTC sender, start and stop it, and read its last error.

Macros


ICY_PIPELINE_API_ABI_VERSION

#define ICY_PIPELINE_API_ABI_VERSION 1u

Defined in src/graft/include/icy/graft/host/pipeline.h:22


ICY_PIPELINE_API_MANIFEST_SYMBOL

#define ICY_PIPELINE_API_MANIFEST_SYMBOL "icy_pipeline_api_manifest"

Defined in src/graft/include/icy/graft/host/pipeline.h:23


ICY_PIPELINE_API_ENTRYPOINT

#define ICY_PIPELINE_API_ENTRYPOINT "icy_pipeline_api"

Defined in src/graft/include/icy/graft/host/pipeline.h:24

Typedefs

ReturnNameDescription
struct icy_pipelineicy_pipeline_t
struct icy_pipeline_optionsicy_pipeline_options_tOptions for icy_pipeline_api.create: the pipeline's name, signalling token, room and ICE server, with struct_size set to the size the caller was built with.
struct icy_pipeline_apiicy_pipeline_api_tThe pipeline host API returned by icy_pipeline_api(): create a pipeline, attach an RTSP source and a WebRTC sender, start and stop it, and read its last error.
const icy_pipeline_api_t (icy_pipeline_api_get_t

icy_pipeline_t

using icy_pipeline_t = struct icy_pipeline

Defined in src/graft/include/icy/graft/host/pipeline.h:33


icy_pipeline_options_t

using icy_pipeline_options_t = struct icy_pipeline_options

Type: struct icy_pipeline_options

Defined in src/graft/include/icy/graft/host/pipeline.h:45

Options for icy_pipeline_api.create: the pipeline's name, signalling token, room and ICE server, with struct_size set to the size the caller was built with.


icy_pipeline_api_t

using icy_pipeline_api_t = struct icy_pipeline_api

Type: struct icy_pipeline_api

Defined in src/graft/include/icy/graft/host/pipeline.h:67

The pipeline host API returned by icy_pipeline_api(): create a pipeline, attach an RTSP source and a WebRTC sender, start and stop it, and read its last error.


icy_pipeline_api_get_t

using icy_pipeline_api_get_t = const icy_pipeline_api_t *(*

Defined in src/graft/include/icy/graft/host/pipeline.h:70

Functions

ReturnNameDescription
const icy_pipeline_api_t *icy_pipeline_api

icy_pipeline_api

const icy_pipeline_api_t * icy_pipeline_api(void)

Defined in src/graft/include/icy/graft/host/pipeline.h:73

Variables


icy_pipeline_api_manifest

ICY_GRAFT_EXTERN_C_BEGIN const icy_graft_manifest_t icy_pipeline_api_manifest

Type: ICY_GRAFT_EXTERN_C_BEGIN const icy_graft_manifest_t

Defined in src/graft/include/icy/graft/host/pipeline.h:30

Edit this page