pydeepstreamdoc::pipeline::PipelineDoc Namespace Reference

Variables
constexpr const char *	descr = R"pydeepstream(Media processing pipeline.)pydeepstream"
constexpr const char *	init = R"pydeepstream(Initialize the pipeline with a name.)pydeepstream"
constexpr const char *	init_with_config = R"pydeepstream(Initialize the pipeline with a name and config file path.)pydeepstream"
constexpr const char *	add
constexpr const char *	attach
constexpr const char *	getitem = R"pydeepstream(Retrieve a :class:`Node` from the pipeline by name.)pydeepstream"
constexpr const char *	start = R"pydeepstream(Start the pipeline.)pydeepstream"
constexpr const char *	start_with_callback = R"pydeepstream(Start the pipeline with a callback to capture messages.)pydeepstream"
constexpr const char *	prepare = R"pydeepstream(Initialize the pipeline.)pydeepstream"
constexpr const char *	prepare_with_callback = R"pydeepstream(Initialize the pipeline with a callback to capture messages.)pydeepstream"
constexpr const char *	activate = R"pydeepstream(Start the pipeline after it is already initialized.)pydeepstream"
constexpr const char *	wait = R"pydeepstream(Wait for the pipeline to finish.)pydeepstream"
constexpr const char *	stop = R"pydeepstream(Stop the pipeline.)pydeepstream"
constexpr const char *	start_rtsp_server = R"pydeepstream(Start the RTSP server.)pydeepstream"
constexpr const char *	seek = R"pydeepstream(Seek to a specified timestamp for processing data within the pipeline.)pydeepstream"
constexpr const char *	start_recording
constexpr const char *	stop_recording
constexpr const char *	stop_recording_by_session_id

Variable Documentation

activate

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::activate = R"pydeepstream(Start the pipeline after it is already initialized.)pydeepstream"

constexpr

Definition at line 101 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

add

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::add

constexpr

Initial value:

= R"pydeepstream(
                Add an element to the pipeline.
 
                :arg type_name: *str*, Type of the element.
                :arg name: *str*, Name of the element.)pydeepstream"

Definition at line 84 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

attach

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::attach

constexpr

Initial value:

= R"pydeepstream(
                Attach an object to an element in the pipeline. Object must be a probe or a signal handler.
 
                :arg element_name: *str*, Name of the element to which the object attaches.
                :arg plugin_name: *str*, Name of the plugin to create the custom object from.
                :arg object: *str*, Name of the custom object.
                :arg tip: *str*, Extra information. Pad name for buffer probes, signal name for signal handlers.)pydeepstream"

Definition at line 89 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

descr

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::descr = R"pydeepstream(Media processing pipeline.)pydeepstream"

constexpr

Definition at line 81 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

getitem

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::getitem = R"pydeepstream(Retrieve a :class:`Node` from the pipeline by name.)pydeepstream"

constexpr

Definition at line 96 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

init

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::init = R"pydeepstream(Initialize the pipeline with a name.)pydeepstream"

constexpr

Definition at line 82 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

init_with_config

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::init_with_config = R"pydeepstream(Initialize the pipeline with a name and config file path.)pydeepstream"

constexpr

Definition at line 83 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

prepare

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::prepare = R"pydeepstream(Initialize the pipeline.)pydeepstream"

constexpr

Definition at line 99 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

prepare_with_callback

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::prepare_with_callback = R"pydeepstream(Initialize the pipeline with a callback to capture messages.)pydeepstream"

constexpr

Definition at line 100 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

seek

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::seek = R"pydeepstream(Seek to a specified timestamp for processing data within the pipeline.)pydeepstream"

constexpr

Definition at line 105 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

start

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::start = R"pydeepstream(Start the pipeline.)pydeepstream"

constexpr

Definition at line 97 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

start_recording

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::start_recording

constexpr

Initial value:

= R"pydeepstream(
                Start recording from a specified source.
 
                :arg source_name: *str*, Name of the source to record.
                :arg start_time: *int*, Start time of the recording.
                :arg duration: *int*, Duration of the recording.)pydeepstream"

Definition at line 106 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

start_rtsp_server

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::start_rtsp_server = R"pydeepstream(Start the RTSP server.)pydeepstream"

constexpr

Definition at line 104 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

start_with_callback

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::start_with_callback = R"pydeepstream(Start the pipeline with a callback to capture messages.)pydeepstream"

constexpr

Definition at line 98 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

stop

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::stop = R"pydeepstream(Stop the pipeline.)pydeepstream"

constexpr

Definition at line 103 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

stop_recording

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::stop_recording

constexpr

Initial value:

= R"pydeepstream(
                Stop recording from a specified source.
 
                :arg source_name: *str*, Name of the source to record.)pydeepstream"

Definition at line 112 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

stop_recording_by_session_id

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::stop_recording_by_session_id

constexpr

Initial value:

= R"pydeepstream(
                Stop recording from a specified session id.
 
                :arg session_id: *int*, Session id to stop recording.)pydeepstream"

Definition at line 116 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().

wait

constexpr const char * pydeepstreamdoc::pipeline::PipelineDoc::wait = R"pydeepstream(Wait for the pipeline to finish.)pydeepstream"

constexpr

Definition at line 102 of file service-maker/sources/python/src/bindings/docstrings/pipelinedoc.h.

Referenced by module_pipeline_bind().