GstMpegts.Descriptor¶
Fields¶
Name |
Type |
Access |
Description |
---|---|---|---|
data |
r/w |
the full descriptor data (including tag, extension, length). The first two bytes are the tag and length. |
|
length |
r/w |
the length of the descriptor content (excluding tag/length field) |
|
tag |
r/w |
the type of descriptor |
|
tag_extension |
r/w |
the extended type (if descriptor_tag is 0x7f) |
Methods¶
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
|
|
|
|
|
|
|
|
Details¶
- class GstMpegts.Descriptor¶
These are the base descriptor types and methods.
For more details, refer to the ITU H.222.0 or ISO/IEC 13818-1 specifications and other specifications mentioned in the documentation.
- classmethod from_custom(tag, data)¶
- Parameters:
- Returns:
- Return type:
Creates a
GstMpegts.Descriptor
with custom tag and data
- classmethod from_custom_with_extension(tag, tag_extension, data)¶
- Parameters:
- Returns:
- Return type:
Creates a
GstMpegts.Descriptor
with custom tag, tag_extension and dataNew in version 1.20.
- classmethod from_dvb_network_name(name)¶
- Parameters:
name (
str
) – the network name to set- Returns:
the
GstMpegts.Descriptor
orNone
on fail- Return type:
Creates a
GstMpegts.Descriptor
to be aGstMpegts.DVBDescriptorType.NETWORK_NAME
, with the network name name. The data field of theGstMpegts.Descriptor
will be allocated, and transferred to the caller.
- classmethod from_dvb_service(service_type, service_name, service_provider)¶
- Parameters:
service_type (
GstMpegts.DVBServiceType
) – Service type defined as aGstMpegts.DVBServiceType
service_provider (
str
orNone
) – Name of the service provider
- Returns:
the
GstMpegts.Descriptor
orNone
on fail- Return type:
Fills a
GstMpegts.Descriptor
to be aGstMpegts.DVBDescriptorType.SERVICE
. The data field of theGstMpegts.Descriptor
will be allocated, and transferred to the caller.
- classmethod from_dvb_subtitling(lang, type, composition, ancillary)¶
- Parameters:
- Return type:
- classmethod from_iso_639_language(language)¶
- Parameters:
- Returns:
GstMpegts.Descriptor
,None
on failure- Return type:
Creates a
GstMpegts.DescriptorType.ISO_639_LANGUAGE
GstMpegts.Descriptor
with a single language
- classmethod from_registration(format_identifier, additional_info)¶
- Parameters:
- Returns:
GstMpegts.Descriptor
,None
on failure- Return type:
Creates a
GstMpegts.DescriptorType.REGISTRATION
GstMpegts.Descriptor
- classmethod parse_audio_preselection_dump(source)¶
- Parameters:
source (
GstMpegts.AudioPreselectionDescriptor
) –
New in version 1.20.
- classmethod parse_audio_preselection_free(source)¶
- Parameters:
source (
GstMpegts.AudioPreselectionDescriptor
) –
New in version 1.20.
- free()¶
Frees self
- parse_audio_preselection_list()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- list:
the list of audio preselection
- Return type:
(
bool
, list: [GstMpegts.AudioPreselectionDescriptor
])
Parses out a list of audio preselection from the self.
New in version 1.20.
- parse_ca()¶
- Returns:
True
if parsing succeeded, elseFalse
.- ca_system_id:
the type of CA system used
- ca_pid:
The PID containing ECM or EMM data
- private_data:
The private data
- Return type:
Extracts the Conditional Access information from self.
- parse_cable_delivery_system()¶
- Returns:
True
if parsing succeeded, elseFalse
.- res:
the
GstMpegts.CableDeliverySystemDescriptor
to fill
- Return type:
Extracts the cable delivery system information from self.
- parse_dvb_bouquet_name()¶
-
Extracts the bouquet name from self.
- parse_dvb_ca_identifier()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- list:
a list of ca identifier. Edge entry identifies the CA system. Allocations of the value of this field are found in http://www.dvbservices.com
- Return type:
Extracts ca id’s from self.
- parse_dvb_component()¶
- Returns:
True
if parsing succeeded, elseFalse
.- res:
the
GstMpegts.ComponentDescriptor
to fill
- Return type:
(
bool
, res:GstMpegts.ComponentDescriptor
)
Extracts the DVB component information from self.
- parse_dvb_content()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- content:
- Return type:
(
bool
, content: [GstMpegts.Content
])
Extracts the DVB content information from self.
- parse_dvb_data_broadcast()¶
- Returns:
- Return type:
Parses out the data broadcast from the self.
- parse_dvb_data_broadcast_id()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- data_broadcast_id:
the data broadcast id
- id_selector_bytes:
the selector bytes, if present
- Return type:
Parses out the data broadcast id from the self.
- parse_dvb_extended_event()¶
- Returns:
True
if parsing succeeded, elseFalse
.- res:
the
GstMpegts.ExtendedEventDescriptor
to fill
- Return type:
Extracts the DVB extended event information from self.
- parse_dvb_frequency_list()¶
- Returns:
- Return type:
Parses out a list of frequencies from the self.
- parse_dvb_linkage()¶
- Returns:
True
if parsing succeeded, elseFalse
.- res:
the
GstMpegts.DVBLinkageDescriptor
to fill
- Return type:
(
bool
, res:GstMpegts.DVBLinkageDescriptor
)
Extracts the DVB linkage information from self.
- parse_dvb_multilingual_bouquet_name()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- bouquet_name_items:
- Return type:
(
bool
, bouquet_name_items: [GstMpegts.DvbMultilingualBouquetNameItem
])
Parses out the multilingual bouquet name from the self.
- parse_dvb_multilingual_component()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- component_tag:
the component tag
- component_description_items:
- Return type:
(
bool
, component_tag:int
, component_description_items: [GstMpegts.DvbMultilingualComponentItem
])
Parses out the multilingual component from the self.
- parse_dvb_multilingual_network_name()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- network_name_items:
- Return type:
(
bool
, network_name_items: [GstMpegts.DvbMultilingualNetworkNameItem
])
Parses out the multilingual network name from the self.
- parse_dvb_multilingual_service_name()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- service_name_items:
- Return type:
(
bool
, service_name_items: [GstMpegts.DvbMultilingualServiceNameItem
])
Parses out the multilingual service name from the self.
- parse_dvb_network_name()¶
-
Parses out the dvb network name from the self:
- parse_dvb_parental_rating()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- rating:
- Return type:
(
bool
, rating: [GstMpegts.DVBParentalRatingItem
])
Extracts the DVB parental rating information from self.
- parse_dvb_private_data_specifier()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- private_data_specifier:
the private data specifier id registered by http://www.dvbservices.com/
- private_data:
additional data or
None
- Return type:
Parses out the private data specifier from the self.
- parse_dvb_scrambling()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- scrambling_mode:
This 8-bit field identifies the selected mode of the scrambling algorithm (
GstMpegts.DVBScramblingModeType
). The technical details of the scrambling algorithm are available only to bona-fide users upon signature of a Non Disclosure Agreement (NDA) administered by the DVB Common Scrambling Algorithm Custodian.
- Return type:
(
bool
, scrambling_mode:GstMpegts.DVBScramblingModeType
)
Parses out the scrambling mode from the self.
- parse_dvb_service()¶
- Returns:
True
if parsing succeeded, elseFalse
.- service_type:
the service type
- service_name:
the service name
- provider_name:
the provider name
- Return type:
(
bool
, service_type:GstMpegts.DVBServiceType
, service_name:str
, provider_name:str
)
Extracts the dvb service information from self.
- parse_dvb_service_list()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- list:
the list of services
- Return type:
(
bool
, list: [GstMpegts.DVBServiceListItem
])
Parses out a list of services from the self:
- parse_dvb_short_event()¶
- Returns:
True
if parsing succeeded, elseFalse
.- language_code:
the language code
- event_name:
the event name
- text:
the event text
- Return type:
Extracts the DVB short event information from self.
- parse_dvb_stream_identifier()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- component_tag:
the component tag
- Return type:
Extracts the component tag from self.
- parse_dvb_stuffing()¶
- Returns:
True
if the parsing happened correctly, elseFalse
.- stuffing_bytes:
the stuffing bytes
- Return type:
Parses out the stuffing bytes from the self.
- parse_dvb_subtitling_idx(idx)¶
- Parameters:
idx (
int
) – Table id of the entry to parse- Returns:
True
if parsing succeeded, elseFalse
.- lang:
the language code
- type:
the type of subtitling
- composition_page_id:
the composition page id
- ancillary_page_id:
the ancillary page id
- Return type:
(
bool
, lang:str
, type:int
, composition_page_id:int
, ancillary_page_id:int
)
Extracts the DVB subtitling informatio from specific table id in self.
Note: Use #gst_tag_get_language_code if you want to get the the ISO 639-1 language code from the returned ISO 639-2 one.
- parse_dvb_t2_delivery_system()¶
- Returns:
- Return type:
Parses out the DVB-T2 delivery system from the self.
- parse_dvb_teletext_idx(idx)¶
- Parameters:
idx (
int
) – The id of the teletext to get- Returns:
False
on out-of-bounds and errors- language_code:
a null-terminated string
- teletext_type:
- Return type:
(
bool
, language_code:str
, teletext_type:GstMpegts.DVBTeletextType
, magazine_number:int
, page_number:int
)
Parses teletext number idx in the self. The language is in ISO639 format.
- parse_dvb_teletext_nb()¶
- Returns:
Number of teletext entries
- Return type:
Find the number of teletext entries in self
- parse_iso_639_language()¶
- Returns:
True
if parsing succeeded, elseFalse
.- res:
the
GstMpegts.ISO639LanguageDescriptor
to fill
- Return type:
Extracts the iso 639-2 language information from self.
Note: Use #gst_tag_get_language_code if you want to get the the ISO 639-1 language code from the returned ISO 639-2 one.
- parse_iso_639_language_idx(idx)¶
- Parameters:
idx (
int
) – Table id of the language to parse- Returns:
True
if parsing succeeded, elseFalse
.- lang:
4-byte
str
array to hold the language code- audio_type:
the
GstMpegts.Iso639AudioType
to set
- Return type:
(
bool
, lang:str
, audio_type:GstMpegts.Iso639AudioType
)
Extracts the iso 639-2 language information from specific table id in self.
Note: Use #gst_tag_get_language_code if you want to get the the ISO 639-1 language code from the returned ISO 639-2 one.
- parse_logical_channel()¶
- Returns:
True
if parsing succeeded, elseFalse
.- res:
the
GstMpegts.LogicalChannelDescriptor
to fill
- Return type:
Extracts the logical channels from self.
- parse_registration()¶
- Returns:
True
if parsing succeeded, elseFalse
.- registration_id:
The registration ID (in host endiannes)
- additional_info:
The additional information
- Return type:
Extracts the Registration information from self.
New in version 1.20.
- parse_satellite_delivery_system()¶
- Returns:
True
if parsing succeeded, elseFalse
.- res:
the
GstMpegts.SatelliteDeliverySystemDescriptor
to fill
- Return type:
Extracts the satellite delivery system information from self.
- parse_terrestrial_delivery_system()¶
- Returns:
- Return type:
Parses out the terrestrial delivery system from the self.