actfw_gstreamer.gstreamer package

Submodules

actfw_gstreamer.gstreamer.converter module

class actfw_gstreamer.gstreamer.converter.ConverterBase

Bases: abc.ABC

abstract convert_sample(sample: GstSample) → Union[result.result.Ok[Any], result.result.Err[Exception]]

Convert GstSample to some value. This class is intended to be used in _GstStream.

Parameters

sample (-) – GstSample

Returns

  • Any, depends on concrete classes

  • Exception

class actfw_gstreamer.gstreamer.converter.ConverterPIL

Bases: actfw_gstreamer.gstreamer.converter.ConverterBase

convert_sample(sample: GstSample) → Union[result.result.Ok[PIL.Image.Image], result.result.Err[Union[RuntimeError, ValueError]]]

Convert GstSample to some value. This class is intended to be used in _GstStream.

Parameters

sample (-) – GstSample

Returns

  • Any, depends on concrete classes

  • Exception

class actfw_gstreamer.gstreamer.converter.ConverterRaw

Bases: actfw_gstreamer.gstreamer.converter.ConverterBase

convert_sample(sample: GstSample) → Union[result.result.Ok[bytes], result.result.Err[RuntimeError]]

Convert GstSample to some value. This class is intended to be used in _GstStream.

Parameters

sample (-) – GstSample

Returns

  • Any, depends on concrete classes

  • Exception

actfw_gstreamer.gstreamer.exception module

exception actfw_gstreamer.gstreamer.exception.ConnectionLostError

Bases: RuntimeError

exception actfw_gstreamer.gstreamer.exception.GstNotInitializedError

Bases: RuntimeError

exception actfw_gstreamer.gstreamer.exception.PipelineBuildError

Bases: RuntimeError

actfw_gstreamer.gstreamer.pipeline module

class actfw_gstreamer.gstreamer.pipeline.AppsinkColorFormat(value)

Bases: enum.Enum

An enumeration.

BGR = 1
RGB = 2
RGBx = 3
class actfw_gstreamer.gstreamer.pipeline.PipelineBuilder(force_format: Optional[actfw_gstreamer.gstreamer.pipeline.AppsinkColorFormat] = None)

Bases: object

add(element: str, props: Dict[str, Any] = {}) → actfw_gstreamer.gstreamer.pipeline.PipelineBuilder
add_appsink_with_caps(props: Dict[str, Any] = {}, caps: Dict[str, Any] = {}) → actfw_gstreamer.gstreamer.pipeline.PipelineBuilder

Effect: Change self.is_finalized() to be true.

Parameters

caps (-) –

dict {

’width’: int, ‘height’: int, ‘framerate’: Optional[int], # Used as framerate={framerate}/1.

}

add_capsfilter(caps_string: str) → actfw_gstreamer.gstreamer.pipeline.PipelineBuilder
finalize() → actfw_gstreamer.gstreamer.pipeline.PipelineGenerator
Returns

is_finalized() → bool
class actfw_gstreamer.gstreamer.pipeline.PipelineGenerator(thunks: List[Any], caps_string: str)

Bases: object

Users should make instances of this class through PipelineBuilder.

build() → Union[result.result.Ok[actfw_gstreamer.gstreamer.pipeline._BuiltPipeline], result.result.Err[actfw_gstreamer.gstreamer.exception.PipelineBuildError]]

actfw_gstreamer.gstreamer.preconfigured_pipeline module

actfw_gstreamer.gstreamer.preconfigured_pipeline.rtsp_h264(proxy: str, location: str, protocols: str, decoder_type: str, caps: Dict[str, Any] = {'height': 480, 'width': 640}) → actfw_gstreamer.gstreamer.pipeline.PipelineGenerator
Create a pipeline like:

rtspsrc proxy=<proxy> location=<location> ! rtph264depay ! h264parse ! <decoder> ! videorate ! videoscale ! videoconvert ! video/x-raw,format=RGB,… ! appsink

where
<decoder> = v4l2h264dec (if decoder_type == ‘v4l2’)

= omxh264dec (if decoder_type == ‘omx’)

Parameters

  • proxy (-) – proxy URL ‘tcp://…’

  • location (-) – rtsp resource location URL ‘rtsp://<host>:<port>/<path>’

  • decoder_type (-) – string, ‘v4l2’ | ‘omx’ | ‘libav’

  • caps (-) –

    dict {

    ’width’: int, ‘height’: int, ‘framerate’: Option[int], // Default: 10

    }

Returns

  • PipelineGenerator

actfw_gstreamer.gstreamer.preconfigured_pipeline.videotestsrc(pattern: str = 'smpte', caps: Dict[str, Any] = {'height': 480, 'width': 640}) → actfw_gstreamer.gstreamer.pipeline.PipelineGenerator
Create a pipeline like:

videotestsrc pattern=<pattern> ! video/x-raw,format=RGB,… ! appsink

Parameters

  • pattern (-) – str, defaults “smpte”.

  • caps (-) –

    dict, {

    ’width’: int, ‘height’: int, ‘framerate’: Option[int], // Default: 10

    }

Returns

  • PipelineGenerator

actfw_gstreamer.gstreamer.stream module

class actfw_gstreamer.gstreamer.stream.GstStreamBuilder(pipeline_generator: actfw_gstreamer.gstreamer.pipeline.PipelineGenerator, converter: Optional[actfw_gstreamer.gstreamer.converter.ConverterBase] = None)

Bases: object

Parameters

  • pipeline_generator (-) – PipelineGenerator

  • converter (-) – ConverterBase, defaults to ConverterRaw.

start_streaming() → actfw_gstreamer.gstreamer.stream._GstStream
Returns

  • _GstStream

exceptions:

  • PipelineBuildError

Module contents