Functions¶

	`buffer_add_mpegts_pes_metadata_meta` (buffer)
	`descriptor_from_custom` (tag, data)
	`descriptor_from_custom_with_extension` (tag, tag_extension, data)
	`descriptor_from_dvb_network_name` (name)
	`descriptor_from_dvb_service` (service_type, service_name, service_provider)
	`descriptor_from_dvb_subtitling` (lang, type, composition, ancillary)
	`descriptor_from_iso_639_language` (language)
	`descriptor_from_jpeg_xs` (jpegxs)
	`descriptor_from_metadata` (metadata_descriptor)
	`descriptor_from_metadata_pointer` (metadata_pointer_descriptor)
	`descriptor_from_registration` (format_identifier, additional_info)
	`descriptor_parse_audio_preselection_dump` (source)
	`descriptor_parse_audio_preselection_free` (source)
	`dvb_component_descriptor_free` (source)
	`event_new_mpegts_section` (section)
	`event_parse_mpegts_section` (event)
	`find_descriptor` (descriptors, tag)
	`find_descriptor_with_extension` (descriptors, tag, tag_extension)
	`initialize` ()
	`message_new_mpegts_section` (parent, section)
	`message_parse_mpegts_section` (message)
	`parse_descriptors` (buffer, buf_len)
	`pat_new` ()
	`pes_metadata_meta_api_get_type` ()
	`pes_metadata_meta_get_info` ()
	`scte_cancel_new` (event_id)
	`scte_null_new` ()
	`scte_splice_in_new` (event_id, splice_time)
	`scte_splice_out_new` (event_id, splice_time, duration)
	`section_from_atsc_mgt` (mgt)
	`section_from_atsc_rrt` (rrt)
	`section_from_atsc_stt` (stt)
	`section_from_nit` (nit)
	`section_from_pat` (programs, ts_id)
	`section_from_pmt` (pmt, pid)
	`section_from_scte_sit` (sit, pid)
	`section_from_sdt` (sdt)

Details¶

GstMpegts.buffer_add_mpegts_pes_metadata_meta(buffer)[source]¶

Parameters:: buffer (Gst.Buffer) – a Gst.Buffer
Returns:: a newly created GstMpegts.PESMetadataMeta
Return type:: GstMpegts.PESMetadataMeta

Creates and adds a GstMpegts.PESMetadataMeta to a buffer.

New in version 1.24.

GstMpegts.descriptor_from_custom(tag, data)[source]¶

Parameters:

tag (int) – descriptor tag
data (bytes) – descriptor data (after tag and length field)

Returns:

GstMpegts.Descriptor, or None if input is invalid

Return type:

GstMpegts.Descriptor or None

Creates a GstMpegts.Descriptor with custom tag and data

GstMpegts.descriptor_from_custom_with_extension(tag, tag_extension, data)[source]¶

Parameters:

tag (int) – descriptor tag
tag_extension (int) – descriptor tag extension
data (bytes) – descriptor data (after tag and length field)

Returns:

GstMpegts.Descriptor

Return type:

GstMpegts.Descriptor

Creates a GstMpegts.Descriptor with custom tag, tag_extension and data

New in version 1.20.

GstMpegts.descriptor_from_dvb_network_name(name)[source]¶

Parameters:: name (str) – the network name to set
Returns:: the GstMpegts.Descriptor or None on failure.
Return type:: GstMpegts.Descriptor or None

Creates a GstMpegts.Descriptor to be a GstMpegts.DVBDescriptorType.NETWORK_NAME, with the network name name. The data field of the GstMpegts.Descriptor will be allocated, and transferred to the caller.

GstMpegts.descriptor_from_dvb_service(service_type, service_name, service_provider)[source]¶

Parameters:

service_type (GstMpegts.DVBServiceType) – Service type defined as a GstMpegts.DVBServiceType
service_name (str or None) – Name of the service
service_provider (str or None) – Name of the service provider

Returns:

the GstMpegts.Descriptor or None on failure

Return type:

GstMpegts.Descriptor or None

Fills a GstMpegts.Descriptor to be a GstMpegts.DVBDescriptorType.SERVICE. The data field of the GstMpegts.Descriptor will be allocated, and transferred to the caller.

GstMpegts.descriptor_from_dvb_subtitling(lang, type, composition, ancillary)[source]¶

Parameters:

lang (str) – a string containing the ISO639 language
type (int) – subtitling type
composition (int) – composition page id
ancillary (int) – ancillary page id

Return type:

GstMpegts.Descriptor

GstMpegts.descriptor_from_iso_639_language(language)[source]¶

Parameters:: language (str) – ISO-639-2 language 3-str code
Returns:: GstMpegts.Descriptor, None on failure
Return type:: GstMpegts.Descriptor

Creates a GstMpegts.DescriptorType.ISO_639_LANGUAGE GstMpegts.Descriptor with a single language

GstMpegts.descriptor_from_jpeg_xs(jpegxs)[source]¶

Parameters:: jpegxs (GstMpegts.JpegXsDescriptor) – A GstMpegts.JpegXsDescriptor
Returns:: The GstMpegts.Descriptor
Return type:: GstMpegts.Descriptor

Create a new GstMpegts.Descriptor based on the information in jpegxs

New in version 1.26.

GstMpegts.descriptor_from_metadata(metadata_descriptor)[source]¶

Parameters:: metadata_descriptor (GstMpegts.MetadataDescriptor) –
Return type:: GstMpegts.Descriptor

New in version 1.26.

GstMpegts.descriptor_from_metadata_pointer(metadata_pointer_descriptor)[source]¶

Parameters:: metadata_pointer_descriptor (GstMpegts.MetadataPointerDescriptor) – a GstMpegts.MetadataPointerDescriptor
Returns:: a GstMpegts.Descriptor from the metadata pointer descriptor.
Return type:: GstMpegts.Descriptor

New in version 1.26.

GstMpegts.descriptor_from_registration(format_identifier, additional_info)[source]¶

Parameters:

format_identifier (str) – a 4 character format identifier string
additional_info (bytes or None) – pointer to optional additional info

Returns:

GstMpegts.Descriptor, None on failure

Return type:

GstMpegts.Descriptor

Creates a GstMpegts.DescriptorType.REGISTRATION GstMpegts.Descriptor

GstMpegts.descriptor_parse_audio_preselection_dump(source)[source]¶

Parameters:: source (GstMpegts.AudioPreselectionDescriptor) –

New in version 1.20.

GstMpegts.descriptor_parse_audio_preselection_free(source)[source]¶

Parameters:: source (GstMpegts.AudioPreselectionDescriptor) –

New in version 1.20.

GstMpegts.dvb_component_descriptor_free(source)[source]¶

Parameters:: source (GstMpegts.ComponentDescriptor) –

GstMpegts.event_new_mpegts_section(section)[source]¶

Parameters:: section (GstMpegts.Section) – The GstMpegts.Section to put in a message
Returns:: The new custom Gst.Event.
Return type:: Gst.Event

Creates a new Gst.Event for a GstMpegts.Section.

New in version 1.20.

GstMpegts.event_parse_mpegts_section(event)[source]¶

Parameters:: event (Gst.Event) – Gst.Event containing a GstMpegts.Section
Returns:: The extracted GstMpegts.Section , or None if the event did not contain a valid GstMpegts.Section.
Return type:: GstMpegts.Section or None

Extracts the GstMpegts.Section contained in the event Gst.Event

GstMpegts.find_descriptor(descriptors, tag)[source]¶

Parameters:

descriptors ([GstMpegts.Descriptor]) – an array of GstMpegts.Descriptor
tag (int) – the tag to look for

Returns:

the first descriptor matching tag, else None.

Return type:

GstMpegts.Descriptor or None

Finds the first descriptor of type tag in the array.

Note: To look for descriptors that can be present more than once in an array of descriptors, iterate the GLib.Array manually.

GstMpegts.find_descriptor_with_extension(descriptors, tag, tag_extension)[source]¶

Parameters:

descriptors ([GstMpegts.Descriptor]) – an array of GstMpegts.Descriptor
tag (int) – the tag to look for
tag_extension (int) –

Returns:

the first descriptor matchin tag with tag_extension, else None.

Return type:

GstMpegts.Descriptor or None

Finds the first descriptor of type tag with tag_extension in the array.

Note: To look for descriptors that can be present more than once in an array of descriptors, iterate the GLib.Array manually.

New in version 1.20.

GstMpegts.initialize()[source]¶: Initializes the MPEG-TS helper library. Must be called before any usage.

GstMpegts.message_new_mpegts_section(parent, section)[source]¶

Parameters:

parent (Gst.Object) – The creator of the message
section (GstMpegts.Section) – The GstMpegts.Section to put in a message

Returns:

The new Gst.Message to be posted, or None if the section is not valid.

Return type:

Gst.Message or None

Creates a new Gst.Message for a GstMpegtsSection.

GstMpegts.message_parse_mpegts_section(message)[source]¶

Parameters:: message (Gst.Message) – a Gst.Message
Returns:: the contained GstMpegts.Section, or None.
Return type:: GstMpegts.Section or None

Returns the GstMpegts.Section contained in a message.

GstMpegts.parse_descriptors(buffer, buf_len)[source]¶

Parameters:

buffer (int) – descriptors to parse
buf_len (int) – Size of buffer

Returns:

an array of the parsed descriptors or None if there was an error. Release with #g_array_unref when done with it.

Return type:

[GstMpegts.Descriptor] or None

Parses the descriptors present in buffer and returns them as an array.

Note: The data provided in buffer will not be copied.

GstMpegts.pat_new()[source]¶

Returns:: A newly allocated GLib.PtrArray
Return type:: [GstMpegts.PatProgram]

Allocates a new GLib.PtrArray for GstMpegts.PatProgram. The array can be filled and then converted to a PAT section with GstMpegts.Section.from_pat().

GstMpegts.pes_metadata_meta_api_get_type()[source]¶

Returns:: a GObject.GType
Return type:: GObject.GType

Return the GObject.GType associated with GstMpegts.PESMetadataMeta

New in version 1.24.

GstMpegts.pes_metadata_meta_get_info()[source]¶

Returns:: The Gst.MetaInfo
Return type:: Gst.MetaInfo

Gets the global Gst.MetaInfo describing the GstMpegts.PESMetadataMeta meta.

New in version 1.24.

GstMpegts.scte_cancel_new(event_id)[source]¶

Parameters:: event_id (int) – The event ID to cancel.
Returns:: A newly allocated GstMpegts.SCTESIT
Return type:: GstMpegts.SCTESIT

Allocates and initializes a new INSERT command GstMpegts.SCTESIT setup to cancel the specified event_id.

GstMpegts.scte_null_new()[source]¶

Returns:: A newly allocated GstMpegts.SCTESIT
Return type:: GstMpegts.SCTESIT

Allocates and initializes a None command GstMpegts.SCTESIT.

GstMpegts.scte_splice_in_new(event_id, splice_time)[source]¶

Parameters:

event_id (int) – The event ID.
splice_time (int) – The running time for the splice event

Returns:

A newly allocated GstMpegts.SCTESIT

Return type:

GstMpegts.SCTESIT

Allocates and initializes a new “Splice In” INSERT command GstMpegts.SCTESIT for the given event_id and splice_time.

If the splice_time is GObject.G_MAXUINT64 then the event will be immediate as opposed to for the target splice_time.

GstMpegts.scte_splice_out_new(event_id, splice_time, duration)[source]¶

Parameters:

event_id (int) – The event ID.
splice_time (int) – The running time for the splice event
duration (int) – The optional duration.

Returns:

A newly allocated GstMpegts.SCTESIT

Return type:

GstMpegts.SCTESIT

Allocates and initializes a new “Splice Out” INSERT command GstMpegts.SCTESIT for the given event_id, splice_time and duration.

If the splice_time is GObject.G_MAXUINT64 then the event will be immediate as opposed to for the target splice_time.

If the duration is 0 it won’t be specified in the event.

GstMpegts.section_from_atsc_mgt(mgt)[source]¶

Parameters:: mgt (GstMpegts.AtscMGT) – a GstMpegts.AtscMGT to create the GstMpegts.Section from
Returns:: the GstMpegts.Section, or None if mgt is invalid
Return type:: GstMpegts.Section or None

GstMpegts.section_from_atsc_rrt(rrt)[source]¶

Parameters:: rrt (GstMpegts.AtscRRT) –
Return type:: GstMpegts.Section

GstMpegts.section_from_atsc_stt(stt)[source]¶

Parameters:: stt (GstMpegts.AtscSTT) –
Return type:: GstMpegts.Section

GstMpegts.section_from_nit(nit)[source]¶

Parameters:: nit (GstMpegts.NIT) – a GstMpegts.NIT to create the GstMpegts.Section from
Returns:: the GstMpegts.Section, or None if nit is invalid
Return type:: GstMpegts.Section or None

Ownership of nit is taken. The data in nit is managed by the GstMpegts.Section

GstMpegts.section_from_pat(programs, ts_id)[source]¶

Parameters:

programs ([GstMpegts.PatProgram]) – an array of GstMpegts.PatProgram
ts_id (int) – Transport stream ID of the PAT

Returns:

a GstMpegts.Section

Return type:

GstMpegts.Section

Creates a PAT GstMpegts.Section from the programs array of GstMpegts.PatPrograms

GstMpegts.section_from_pmt(pmt, pid)[source]¶

Parameters:

pmt (GstMpegts.PMT) – a GstMpegts.PMT to create a GstMpegts.Section from
pid (int) – The PID that the GstMpegts.PMT belongs to

Returns:

GstMpegts.Section, or None if pmt is invalid

Return type:

GstMpegts.Section or None

Creates a GstMpegts.Section from pmt that is bound to pid

GstMpegts.section_from_scte_sit(sit, pid)[source]¶

Parameters:

sit (GstMpegts.SCTESIT) – a GstMpegts.SCTESIT to create the GstMpegts.Section from
pid (int) –

Returns:

the GstMpegts.Section, or None if sit is invalid

Return type:

GstMpegts.Section or None

Ownership of sit is taken. The data in sit is managed by the GstMpegts.Section

GstMpegts.section_from_sdt(sdt)[source]¶

Parameters:: sdt (GstMpegts.SDT) – a GstMpegts.SDT to create the GstMpegts.Section from
Returns:: the GstMpegts.Section or None if sdt is invalid
Return type:: GstMpegts.Section or None

Ownership of sdt is taken. The data in sdt is managed by the GstMpegts.Section