rrmsutils.models.bips package
Submodules
rrmsutils.models.bips.stream module
Stream model
- class rrmsutils.models.bips.stream.Stream(*, name: str, uri: str)
Bases:
BaseModel
Stream Model
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'name': FieldInfo(annotation=str, required=True), 'uri': FieldInfo(annotation=str, required=True)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- name: str
The Stream Name. It will be used to create the channel to share buffers
- uri: str
RTSP Stream URI
rrmsutils.models.bips.streamlist module
StreamList model
- class rrmsutils.models.bips.streamlist.Buffer(*, width: int, height: int, format: str, size: int)
Bases:
BaseModel
Buffer Model
- format: str
Buffer format
- height: int
Buffer height
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'format': FieldInfo(annotation=str, required=True), 'height': FieldInfo(annotation=int, required=True), 'size': FieldInfo(annotation=int, required=True), 'width': FieldInfo(annotation=int, required=True)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- size: int
Buffer size
- width: int
Buffer width
- class rrmsutils.models.bips.streamlist.Item(*, name: str, uri: str, buffer: Buffer, buffers: int)
Bases:
BaseModel
Item Model
- buffers: int
Number of buffers used by bips
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'buffer': FieldInfo(annotation=Buffer, required=True), 'buffers': FieldInfo(annotation=int, required=True), 'name': FieldInfo(annotation=str, required=True), 'uri': FieldInfo(annotation=str, required=True)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- name: str
Stream (channel) name
- uri: str
RTSP Stream URI
- class rrmsutils.models.bips.streamlist.StreamList(*, streams: List[Item])
Bases:
BaseModel
Stream List Model
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'streams': FieldInfo(annotation=List[Item], required=True)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.