simple_capture.source package

Submodules

simple_capture.source.devices module

Contains simple_capture.source.devices.Device base class and the simple_capture.source.devices.DeviceType enum to be used in input and output device classes.

class simple_capture.source.devices.Device(**kwargs)

Bases: simple_capture.utils.RegistryEnabledObject

Device base class.

abstract property device

The source or sink of the device.

Type

str

abstract property ffmpeg_arguments

Keyword arguments to be provided to the ffmpeg node constructor.

Type

dict(str, str)

class simple_capture.source.devices.DeviceType(value)

Bases: enum.Enum

Enum to indicate the type of device.

ANY = 1
AUDIO = 2
NONE = 3
VIDEO = 4
simple_capture.source.devices.device(registry_enabled_object, *, name_attribute='device_name')

Decorator factory. Used to add a class to a registry. >>> class Ham(RegistryEnabledObject): … _reg = {} … @classmethod … def retrieve_registry(cls): … return _reg … >>> @class_attribute_register(Ham, ‘name’): … class Eggs: … name = spam … >>> Ham.retrieve_registry()[‘spam’] <class ‘__main__.Eggs’>

Unlike simple_capture.utils.register(), this retrieves the name through a class attribute. This is useful when adding a base class to its own registry, see simple_capture.source.filters.Filter.

Parameters

  • registry_enabled_object (type) – Class containing target registry.

  • name_attribute (str) – Name of class attribute specifying name in registry.

Returns

Decorator to register class.

Return type

callable

simple_capture.source.devices.register_device(registry_enabled_object, name)

Decorator factory. Used to add a class to a registry. >>> class Ham(RegistryEnabledObject): … _reg = {} … @classmethod … def retrieve_registry(cls): … return _reg … >>> @register(Ham, ‘spam’) … class Eggs: … pass … >>> Ham.retrieve_registry()[‘spam’] <class ‘__main__.Eggs’>

Parameters

  • registry_enabled_object (type) – Class containing target registry.

  • name (str) – Name of member in registry.

Returns

Decorator to register class.

Return type

callable

simple_capture.source.filters module

simple_capture.source.global_options module

simple_capture.source.input_devices module

simple_capture.source.input_streams module

simple_capture.source.output_devices module

simple_capture.source.output_streams module

simple_capture.source.streams module

Contains Stream base class to be used in input and output stream classes.

class simple_capture.source.streams.Stream(**kwargs)

Bases: simple_capture.utils.RegistryEnabledObject

Stream base class.

abstract property ffmpeg_arguments

Keyword arguments to be provided to the ffmpeg node constructor.

Type

dict(str, str)

abstract property filename

The working filename of the stream.

Type

str

simple_capture.source.streams.register_stream(registry_enabled_object, name)

Decorator factory. Used to add a class to a registry. >>> class Ham(RegistryEnabledObject): … _reg = {} … @classmethod … def retrieve_registry(cls): … return _reg … >>> @register(Ham, ‘spam’) … class Eggs: … pass … >>> Ham.retrieve_registry()[‘spam’] <class ‘__main__.Eggs’>

Parameters

  • registry_enabled_object (type) – Class containing target registry.

  • name (str) – Name of member in registry.

Returns

Decorator to register class.

Return type

callable

simple_capture.source.streams.stream(registry_enabled_object, *, name_attribute='stream_name')

Decorator factory. Used to add a class to a registry. >>> class Ham(RegistryEnabledObject): … _reg = {} … @classmethod … def retrieve_registry(cls): … return _reg … >>> @class_attribute_register(Ham, ‘name’): … class Eggs: … name = spam … >>> Ham.retrieve_registry()[‘spam’] <class ‘__main__.Eggs’>

Unlike simple_capture.utils.register(), this retrieves the name through a class attribute. This is useful when adding a base class to its own registry, see simple_capture.source.filters.Filter.

Parameters

  • registry_enabled_object (type) – Class containing target registry.

  • name_attribute (str) – Name of class attribute specifying name in registry.

Returns

Decorator to register class.

Return type

callable

Module contents

Contains FFmpeg elements.