PbUtils

---

Description:

Content:

Classes:

• AudioVisualizer - A baseclass for scopes (visualizers).
• Discoverer - The Discoverer is a utility object which allows to get as much information as possible from one or many URIs.
• DiscovererAudioInfo - DiscovererStreamInfo specific to audio streams.
• DiscovererContainerInfo - DiscovererStreamInfo specific to container streams.
• DiscovererInfo - Structure containing the information of a URI analyzed by Discoverer.
• DiscovererStreamInfo - Base structure for information concerning a media stream.
• DiscovererSubtitleInfo - DiscovererStreamInfo specific to subtitle streams (this includes text and image based ones).
• DiscovererVideoInfo - DiscovererStreamInfo specific to video streams (this includes images).
• EncodingAudioProfile - Variant of EncodingProfile for audio streams.
• EncodingContainerProfile - Encoding profiles for containers.
• EncodingProfile - The opaque base class object for all encoding profiles.
• EncodingTarget - Collection of EncodingProfile for a specific target or use-case.
• EncodingVideoProfile - Variant of EncodingProfile for video streams, allows specifying the pass.
• InstallPluginsContext - Opaque context structure for the plugin installation.

Enums:

• AudioVisualizerShader - Different types of supported background shading functions.
• DiscovererResult - Result values for the discovery process.
• DiscovererSerializeFlags - You can use these flags to control what is serialized by to_variant
• InstallPluginsReturn - Result codes returned by install_plugins_async and install_plugins_sync, and also the result code passed to the InstallPluginsResultFunc specified with install_plugins_async.
• PbUtilsCapsDescriptionFlags - Flags that are returned by get_caps_description_flags and describe the format of the caps.

Constants:

• public const string ENCODING_CATEGORY_CAPTURE
  EncodingTarget category for recording and capture.
• public const string ENCODING_CATEGORY_DEVICE
  EncodingTarget category for device-specific targets.
• public const string ENCODING_CATEGORY_FILE_EXTENSION
  EncodingTarget category for file extensions.
• public const string ENCODING_CATEGORY_ONLINE_SERVICE
  EncodingTarget category for online-services.
• public const string ENCODING_CATEGORY_STORAGE_EDITING
  EncodingTarget category for storage, archiving and editing targets.
• public const int PLUGINS_BASE_VERSION_MAJOR
  The major version of GStreamer's gst-plugins-base libraries at compile time.
• public const int PLUGINS_BASE_VERSION_MICRO
  The micro version of GStreamer's gst-plugins-base libraries at compile time.
• public const int PLUGINS_BASE_VERSION_MINOR
  The minor version of GStreamer's gst-plugins-base libraries at compile time.
• public const int PLUGINS_BASE_VERSION_NANO
  The nano version of GStreamer's gst-plugins-base libraries at compile time.

Delegates:

• public delegate void AudioVisualizerShaderFunc (AudioVisualizer scope, Frame s, Frame d)
• public delegate void InstallPluginsResultFunc (InstallPluginsReturn result)
  The prototype of the callback function that will be called once the external plugin installer program has returned.

Methods:

• public bool add_codec_description_to_tag_list (TagList taglist, string? codec_tag, Caps caps)
  Adds a codec tag describing the format specified by caps to taglist.
• public Caps? codec_utils_caps_from_mime_codec (string codecs_field)
  Converts a RFC 6381 compatible codec string to Caps.
• public string? codec_utils_caps_get_mime_codec (Caps caps)
  Converts caps to a RFC 6381 compatible codec string if possible.
• public bool codec_utils_h265_caps_set_level_tier_and_profile (Caps caps, uint8[] profile_tier_level)
  Sets the level, tier and profile in caps if it can be determined from profile_tier_level.
• public unowned string? codec_utils_h265_get_level (uint8[] profile_tier_level)
  Converts the level indication (general_level_idc) in the stream's profile_tier_level structure into a string.
• public uint8 codec_utils_h265_get_level_idc (string level)
  Transform a level string from the caps into the level_idc
• public unowned string? codec_utils_h265_get_profile (uint8[] profile_tier_level)
  Converts the profile indication (general_profile_idc) in the stream's profile_level_tier structure into a string.
• public unowned string? codec_utils_h265_get_tier (uint8[] profile_tier_level)
  Converts the tier indication (general_tier_flag) in the stream's profile_tier_level structure into a string.
• public Caps codec_utils_opus_create_caps (uint32 rate, uint8 channels, uint8 channel_mapping_family, uint8 stream_count, uint8 coupled_count, uint8[]? channel_mapping)
  Creates Opus caps from the given parameters.
• public Caps codec_utils_opus_create_caps_from_header (Buffer header, Buffer? comments)
  Creates Opus caps from the given OpusHead header and comment header comments.
• public Buffer codec_utils_opus_create_header (uint32 rate, uint8 channels, uint8 channel_mapping_family, uint8 stream_count, uint8 coupled_count, uint8[]? channel_mapping, uint16 pre_skip, int16 output_gain)
  Creates OpusHead header from the given parameters.
• public bool codec_utils_opus_parse_caps (Caps caps, out uint32 rate, out uint8 channels, out uint8 channel_mapping_family, out uint8 stream_count, out uint8 coupled_count, out uint8[] channel_mapping)
  Parses Opus caps and fills the different fields with defaults if possible.
• public bool codec_utils_opus_parse_header (Buffer header, out uint32 rate, out uint8 channels, out uint8 channel_mapping_family, out uint8 stream_count, out uint8 coupled_count, out uint8[] channel_mapping, out uint16 pre_skip, out int16 output_gain)
  Parses the OpusHead header.
• public List<EncodingTarget> encoding_list_all_targets (string? categoryname)
  List all available EncodingTarget for the specified category, or all categories if categoryname is null.
• public List<string> encoding_list_available_categories ()
  Lists all EncodingTarget categories present on disk.
• public PbUtilsCapsDescriptionFlags get_caps_description_flags (Caps caps)
  Returns flags that describe the format of the caps if known.
• public string get_codec_description (Caps caps)
  Returns a localised (as far as this is possible) string describing the media format specified in caps, for use in error dialogs or other messages to be seen by the user.
• public string get_decoder_description (Caps caps)
  Returns a localised string describing an decoder for the format specified in caps, for use in error dialogs or other messages to be seen by the user.
• public string get_element_description (string factory_name)
  Returns a localised string describing the given element, for use in error dialogs or other messages to be seen by the user.
• public string get_encoder_description (Caps caps)
  Returns a localised string describing an encoder for the format specified in caps, for use in error dialogs or other messages to be seen by the user.
• public string? get_file_extension_from_caps (Caps caps)
  Returns a possible file extension for the given caps, if known.
• public string get_sink_description (string protocol)
  Returns a localised string describing a sink element handling the protocol specified in protocol, for use in error dialogs or other messages to be seen by the user.
• public string get_source_description (string protocol)
  Returns a localised string describing a source element handling the protocol specified in protocol, for use in error dialogs or other messages to be seen by the user.
• public void init ()
  Initialises the base utils support library.
• public InstallPluginsReturn install_plugins_async (string[] details, InstallPluginsContext? ctx, InstallPluginsResultFunc func)
  Requests plugin installation without blocking.
• public bool install_plugins_installation_in_progress ()
  Checks whether plugin installation (initiated by this application only) is currently in progress.
• public unowned string install_plugins_return_get_name (InstallPluginsReturn ret)
• public bool install_plugins_supported ()
  Checks whether plugin installation is likely to be supported by the current environment.
• public InstallPluginsReturn install_plugins_sync (string[] details, InstallPluginsContext? ctx)
  Requests plugin installation and block until the plugins have been installed or installation has failed.
• public bool is_missing_plugin_message (Message msg)
  Checks whether msg is a missing plugins message.
• public string missing_decoder_installer_detail_new (Caps decode_caps)
  Returns an opaque string containing all the details about the missing element to be passed to an external installer called via install_plugins_async or install_plugins_sync.
• public Message missing_decoder_message_new (Element element, Caps decode_caps)
  Creates a missing-plugin message for element to notify the application that a decoder element for a particular set of (fixed) caps is missing.
• public string missing_element_installer_detail_new (string factory_name)
  Returns an opaque string containing all the details about the missing element to be passed to an external installer called via install_plugins_async or install_plugins_sync.
• public Message missing_element_message_new (Element element, string factory_name)
  Creates a missing-plugin message for element to notify the application that a certain required element is missing.
• public string missing_encoder_installer_detail_new (Caps encode_caps)
  Returns an opaque string containing all the details about the missing element to be passed to an external installer called via install_plugins_async or install_plugins_sync.
• public Message missing_encoder_message_new (Element element, Caps encode_caps)
  Creates a missing-plugin message for element to notify the application that an encoder element for a particular set of (fixed) caps is missing.
• public string missing_plugin_message_get_description (Message msg)
  Returns a localised string describing the missing feature, for use in error dialogs and the like.
• public string missing_plugin_message_get_installer_detail (Message msg)
  Returns an opaque string containing all the details about the missing element to be passed to an external installer called via install_plugins_async or install_plugins_sync.
• public string missing_uri_sink_installer_detail_new (string protocol)
  Returns an opaque string containing all the details about the missing element to be passed to an external installer called via install_plugins_async or install_plugins_sync.
• public Message missing_uri_sink_message_new (Element element, string protocol)
  Creates a missing-plugin message for element to notify the application that a sink element for a particular URI protocol is missing.
• public string missing_uri_source_installer_detail_new (string protocol)
  Returns an opaque string containing all the details about the missing element to be passed to an external installer called via install_plugins_async or install_plugins_sync.
• public Message missing_uri_source_message_new (Element element, string protocol)
  Creates a missing-plugin message for element to notify the application that a source element for a particular URI protocol is missing.
• public void plugins_base_version (out uint major, out uint minor, out uint micro, out uint nano)
  Gets the version number of the GStreamer Plugins Base libraries.
• public string plugins_base_version_string ()
  This function returns a string that is useful for describing this version of GStreamer's gst-plugins-base libraries to the outside world: user agent strings, logging, about dialogs ...