gstreamer-pbutils-0.10

---

Description:

Content:

Namespaces:

• Gst

Classes:

• Discoverer - The Discoverer is a utility object which allows to get as much information as possible from one or many URIs. It provides two APIs, allowing usage in blocking or non-blocking mode. The blocking mode just requires calling discover_uri with the URI one wishes to discover. The non-blocking mode requires a running MainLoop in the default MainContext, where one connects to the various signals, appends the URIs to be processed (through discover_uri_async) and then asks for the discovery to begin (through start). All the information is returned in a DiscovererInfo structure.
• 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. Depending on the stream type, one can find more media-specific information in DiscovererAudioInfo, DiscovererVideoInfo, and DiscovererContainerInfo. The DiscovererStreamInfo represents the topology of the stream. Siblings can be iterated over with get_next and get_previous. Children (sub-streams) of a stream can be accessed using the DiscovererContainerInfo API. As a simple example, if you run Discoverer on an AVI file with one audio and one video stream, you will get a DiscovererContainerInfo corresponding to the AVI container, which in turn will have a DiscovererAudioInfo sub-stream and a DiscovererVideoInfo sub-stream for the audio and video streams respectively.
• DiscovererVideoInfo - DiscovererStreamInfo specific to video streams (this includes images).
• EncodingAudioProfile - Variant of EncodingProfile for audio streams.
• EncodingContainerProfile - Encoding profiles for containers. Keeps track of a list of EncodingProfile
• EncodingProfile - The opaque base class object for all encoding profiles. This contains generic information like name, description, format and preset.
• EncodingTarget - Collection of EncodingProfile for a specific target or use-case. When being stored/loaded, targets come from a specific category, like ENCODING_CATEGORY_DEVICE.
• EncodingVideoProfile - Variant of EncodingProfile for video streams, allows specifying the pass.
• InstallPluginsContext - Opaque context structure for the plugin installation. Use the provided API to set details on it.

Enums:

• DiscovererResult - Result values for the discovery process.
• InstallPluginsReturn - Result codes returned by install_plugins_async and install_plugins_sync, and also the result code passed to the InstallPluginsResultFunc specified with gst_install_plugin_async. These codes indicate success or failure of starting an external installer program and to what extent the requested plugins could be installed.

Constants:

• public const unowned string ENCODING_CATEGORY_CAPTURE
• public const unowned string ENCODING_CATEGORY_DEVICE
• public const unowned string ENCODING_CATEGORY_ONLINE_SERVICE
• public const unowned string ENCODING_CATEGORY_STORAGE_EDITING
• public const int PLUGINS_BASE_VERSION_MAJOR
• public const int PLUGINS_BASE_VERSION_MICRO
• public const int PLUGINS_BASE_VERSION_MINOR
• public const int PLUGINS_BASE_VERSION_NANO

Delegates:

• public delegate void InstallPluginsResultFunc (InstallPluginsReturn result)

Methods:

• public bool codec_utils_aac_caps_set_level_and_profile (Caps caps, uchar[] audio_config)
  Sets the level and profile on caps if it can be determined from codec_utils_aac_get_profile for more details on the parameters. If mpegversion is 4, the "base-profile" field is also set in caps.
• public unowned string codec_utils_aac_get_level (uchar[] audio_config)
  Determines the level of a stream as defined in ISO/IEC 14496-3. For AAC LC streams, the constraints from the AAC audio profile are applied. For AAC Main, LTP, SSR and others, the Main profile is used. The audio_config parameter follows the following format, starting from the most significant bit of the first byte:
• public unowned string codec_utils_aac_get_profile (uchar[] audio_config)
  Returns the profile of the given AAC stream as a string. The profile is determined using the AudioObjectType field which is in the first 5 bits of
• public uint codec_utils_aac_get_sample_rate_from_index (uint sr_idx)
  Translates the sample rate index found in AAC headers to the actual sample rate.
• public bool codec_utils_h264_caps_set_level_and_profile (Caps caps, uchar[] sps)
  Sets the level and profile in caps if it can be determined from sps. See codec_utils_h264_get_level and codec_utils_h264_get_profile for more details on the parameters.
• public unowned string codec_utils_h264_get_level (uchar[] sps)
  Converts the level indication (level_idc) in the stream's sequence parameter set into a string. The SPS is expected to have the same format as for codec_utils_h264_get_profile.
• public uchar codec_utils_h264_get_level_idc (string level)
• public unowned string codec_utils_h264_get_profile (uchar[] sps)
  Converts the profile indication (profile_idc) in the stream's sequence parameter set into a string. The SPS is expected to have the following format, as defined in the H.264 specification. The SPS is viewed as a bitstream here, with bit 0 being the most significant bit of the first byte.
• public bool codec_utils_mpeg4video_caps_set_level_and_profile (Caps caps, uchar[] vis_obj_seq)
  Sets the level and profile in caps if it can be determined from codec_utils_mpeg4video_get_profile for more details on the parameters.
• public unowned string codec_utils_mpeg4video_get_level (uchar[] vis_obj_seq)
  Converts the level indication in the stream's visual object sequence into a string. vis_obj_seq is expected to be the data following the visual object sequence start code. Only the first byte (profile_and_level_indication) is used.
• public unowned string codec_utils_mpeg4video_get_profile (uchar[] vis_obj_seq)
  Converts the profile indication in the stream's visual object sequence into a string. vis_obj_seq is expected to be the data following the visual object sequence start code. Only the first byte (profile_and_level_indication) is used.
• 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. of EncodingTarget categories.
• public InstallPluginsReturn install_plugins_async (string[] details, InstallPluginsContext? ctx, InstallPluginsResultFunc func)
  Requests plugin installation without blocking. Once the plugins have been installed or installation has failed, func will be called with the result of the installation and your provided user_data pointer. This function requires a running GLib/Gtk main loop. If you are not running a GLib/Gtk main loop, make sure to regularly call g_main_context_iteration(NULL,FALSE). The installer strings that make up detail are typically obtained by calling missing_plugin_message_get_installer_detail on missing-plugin messages that have been caught on a pipeline's bus or created by the application via the provided API, such as missing_element_message_new. It is possible to request the installation of multiple missing plugins in one go (as might be required if there is a demuxer for a certain format installed but no suitable video decoder and no suitable audio decoder).
• 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)
  Convenience function to return the descriptive string associated with a status code. This function returns English strings and should not be used for user messages. It is here only to assist in debugging.
• public bool install_plugins_supported ()
  Checks whether plugin installation is likely to be supported by the current environment. This currently only checks whether the helper script that is to be provided by the distribution or operating system vendor exists.
• public InstallPluginsReturn install_plugins_sync (string details, InstallPluginsContext ctx)
  Requests plugin installation and block until the plugins have been installed or installation has failed. This function should almost never be used, it only exists for cases where a non-GLib main loop is running and the user wants to run it in a separate thread and marshal the result back asynchronously into the main thread using the other non-GLib main loop. You should almost always use install_plugins_async instead of this function.
• 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. This function is mainly for applications that call external plugin installation mechanisms using one of the two above-mentioned functions in the case where the application knows exactly what kind of plugin it is missing. with g_free when not needed any longer.
• 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. This function is mainly for use in plugins.
• 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. This function is mainly for applications that call external plugin installation mechanisms using one of the two above-mentioned functions in the case where the application knows exactly what kind of plugin it is missing. with g_free when not needed any longer.
• 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. This function is mainly for use in plugins.
• 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. This function is mainly for applications that call external plugin installation mechanisms using one of the two above-mentioned functions in the case where the application knows exactly what kind of plugin it is missing. with g_free when not needed any longer.
• 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. This function is mainly for use in plugins.
• 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. Should never return NULL unless msg is not a valid missing-plugin message. This function is mainly for applications that need a human-readable string describing a missing plugin, given a previously collected missing-plugin message string with g_free when not needed any longer.
• 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. This function is mainly for applications that call external plugin installation mechanisms using one of the two above-mentioned functions. with g_free when not needed any longer.
• 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. This function is mainly for applications that call external plugin installation mechanisms using one of the two above-mentioned functions in the case where the application knows exactly what kind of plugin it is missing. with g_free when not needed any longer.
• 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. This function is mainly for use in plugins.
• 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. This function is mainly for applications that call external plugin installation mechanisms using one of the two above-mentioned functions in the case where the application knows exactly what kind of plugin it is missing. with g_free when not needed any longer.
• 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. This function is mainly for use in plugins.
• public bool pb_utils_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 unowned string pb_utils_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. Should never return NULL unless caps is invalid. Also see the convenience function pb_utils_add_codec_description_to_tag_list. string with g_free when not needed any longer.
• public unowned string pb_utils_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. Should never return NULL unless factory_name or caps are invalid. This function is mainly for internal use, applications would typically use missing_plugin_message_get_description to get a description of a missing feature from a missing-plugin message. string with g_free when not needed any longer.
• public unowned string pb_utils_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. Should never return NULL unless factory_name is invalid. This function is mainly for internal use, applications would typically use missing_plugin_message_get_description to get a description of a missing feature from a missing-plugin message. string with g_free when not needed any longer.
• public unowned string pb_utils_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. Should never return NULL unless factory_name or caps are invalid. This function is mainly for internal use, applications would typically use missing_plugin_message_get_description to get a description of a missing feature from a missing-plugin message. string with g_free when not needed any longer.
• public unowned string pb_utils_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. Should never return NULL unless protocol is invalid. This function is mainly for internal use, applications would typically use missing_plugin_message_get_description to get a description of a missing feature from a missing-plugin message. string with g_free when not needed any longer.
• public unowned string pb_utils_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. Should never return NULL unless protocol is invalid. This function is mainly for internal use, applications would typically use missing_plugin_message_get_description to get a description of a missing feature from a missing-plugin message. string with g_free when not needed any longer.
• public void pb_utils_init ()
  Initialises the base utils support library. This function is not thread-safe. Applications should call it after calling init, plugins should call it from their plugin_init function. This function may be called multiple times. It will do nothing if the library has already been initialised.
• public void plugins_base_version (uint major, uint minor, uint micro, uint nano)
  Gets the version number of the GStreamer Plugins Base libraries.
• public unowned string plugins_base_version_string ()
  This function returns a string that is useful for describing this version strings, logging, about dialogs ...