Struct GStreamingCompiled

pub struct GStreamingCompiled { /* private fields */ }

\addtogroup gapi_main_classes /

Represents a computation (graph) compiled for streaming.

This class represents a product of graph compilation (calling cv::GComputation::compileStreaming()). Objects of this class actually do stream processing, and the whole pipeline execution complexity is incapsulated into objects of this class. Execution model has two levels: at the very top, the execution of a heterogeneous graph is aggressively pipelined; at the very bottom the execution of every internal block is determined by its associated backend. Backends are selected based on kernel packages passed via compilation arguments ( see [gapi_compile_args], GNetworkPackage, GKernelPackage for details).

GStreamingCompiled objects have a “player” semantics – there are methods like start() and stop(). GStreamingCompiled has a full control over a videostream and so is stateful. You need to specify the input stream data using setSource() and then call start() to actually start processing. After that, use pull() or try_pull() to obtain next processed data frame from the graph in a blocking or non-blocking way, respectively.

Currently a single GStreamingCompiled can process only one video streat at time. Produce multiple GStreamingCompiled objects to run the same graph on multiple video streams.

See also

GCompiled

Implementations

impl GStreamingCompiled

pub fn default() -> Result<GStreamingCompiled>

Trait Implementations

impl Boxed for GStreamingCompiled

unsafe fn from_raw( ptr: <GStreamingCompiled as OpenCVFromExtern>::ExternReceive, ) -> Self

Wrap the specified raw pointer

fn into_raw( self, ) -> <GStreamingCompiled as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw( &self, ) -> <GStreamingCompiled as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self, ) -> <GStreamingCompiled as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Clone for GStreamingCompiled

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GStreamingCompiled

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for GStreamingCompiled

fn drop(&mut self)

Executes the destructor for this type.

impl GStreamingCompiledTrait for GStreamingCompiled

fn as_raw_mut_GStreamingCompiled(&mut self) -> *mut c_void

fn set_source(&mut self, ins: GRunArgs) -> Result<()>

Specify the input data to GStreamingCompiled for processing, a generic version.

fn set_source_1( &mut self, callback: &impl Detail_ExtractArgsCallbackTraitConst, ) -> Result<()>

@private – Exclude this function from OpenCV documentation

fn start(&mut self) -> Result<()>

Start the pipeline execution.

fn stop(&mut self) -> Result<()>

Stop (abort) processing the pipeline.

impl GStreamingCompiledTraitConst for GStreamingCompiled

fn as_raw_GStreamingCompiled(&self) -> *const c_void

fn running(&self) -> Result<bool>

Test if the pipeline is running.

fn to_bool(&self) -> Result<bool>

Check if compiled object is valid (non-empty)

impl Send for GStreamingCompiled