Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
- Methods
- codecUtilsAacCapsSetLevelAndProfile
- codecUtilsAacGetChannels
- codecUtilsAacGetIndexFromSampleRate
- codecUtilsAacGetLevel
- codecUtilsAacGetProfile
- codecUtilsAacGetSampleRate
- codecUtilsAacGetSampleRateFromIndex
- codecUtilsH264CapsSetLevelAndProfile
- codecUtilsH264GetLevel
- codecUtilsH264GetLevelIdc
- codecUtilsH264GetProfile
- codecUtilsH265CapsSetLevelTierAndProfile
- codecUtilsH265GetLevel
- codecUtilsH265GetLevelIdc
- codecUtilsH265GetProfile
- codecUtilsH265GetTier
- codecUtilsMpeg4videoCapsSetLevelAndProfile
- codecUtilsMpeg4videoGetLevel
- codecUtilsMpeg4videoGetProfile
- codecUtilsOpusCreateCaps
- codecUtilsOpusCreateCapsFromHeader
- codecUtilsOpusCreateHeader
- codecUtilsOpusParseCaps
- codecUtilsOpusParseHeader
- encodingListAllTargets
- encodingListAvailableCategories
- installPluginsAsync
- installPluginsInstallationInProgress
- installPluginsSupported
- installPluginsSync
- isMissingPluginMessage
- missingDecoderInstallerDetailNew
- missingDecoderMessageNew
- missingElementInstallerDetailNew
- missingElementMessageNew
- missingEncoderInstallerDetailNew
- missingEncoderMessageNew
- missingPluginMessageGetDescription
- missingPluginMessageGetInstallerDetail
- missingUriSinkInstallerDetailNew
- missingUriSinkMessageNew
- missingUriSourceInstallerDetailNew
- missingUriSourceMessageNew
- pbUtilsAddCodecDescriptionToTagList
- pbUtilsGetCodecDescription
- pbUtilsGetDecoderDescription
- pbUtilsGetElementDescription
- pbUtilsGetEncoderDescription
- pbUtilsGetSinkDescription
- pbUtilsGetSourceDescription
- pbUtilsInit
- pluginsBaseVersion
- pluginsBaseVersionString
Synopsis
- codecUtilsAacCapsSetLevelAndProfile :: (HasCallStack, MonadIO m) => Caps -> ByteString -> m Bool
- codecUtilsAacGetChannels :: (HasCallStack, MonadIO m) => ByteString -> m Word32
- codecUtilsAacGetIndexFromSampleRate :: (HasCallStack, MonadIO m) => Word32 -> m Int32
- codecUtilsAacGetLevel :: (HasCallStack, MonadIO m) => ByteString -> m Text
- codecUtilsAacGetProfile :: (HasCallStack, MonadIO m) => ByteString -> m Text
- codecUtilsAacGetSampleRate :: (HasCallStack, MonadIO m) => ByteString -> m Word32
- codecUtilsAacGetSampleRateFromIndex :: (HasCallStack, MonadIO m) => Word32 -> m Word32
- codecUtilsH264CapsSetLevelAndProfile :: (HasCallStack, MonadIO m) => Caps -> ByteString -> m Bool
- codecUtilsH264GetLevel :: (HasCallStack, MonadIO m) => ByteString -> m Text
- codecUtilsH264GetLevelIdc :: (HasCallStack, MonadIO m) => Text -> m Word8
- codecUtilsH264GetProfile :: (HasCallStack, MonadIO m) => ByteString -> m Text
- codecUtilsH265CapsSetLevelTierAndProfile :: (HasCallStack, MonadIO m) => Caps -> ByteString -> m Bool
- codecUtilsH265GetLevel :: (HasCallStack, MonadIO m) => ByteString -> m Text
- codecUtilsH265GetLevelIdc :: (HasCallStack, MonadIO m) => Text -> m Word8
- codecUtilsH265GetProfile :: (HasCallStack, MonadIO m) => ByteString -> m Text
- codecUtilsH265GetTier :: (HasCallStack, MonadIO m) => ByteString -> m Text
- codecUtilsMpeg4videoCapsSetLevelAndProfile :: (HasCallStack, MonadIO m) => Caps -> ByteString -> m Bool
- codecUtilsMpeg4videoGetLevel :: (HasCallStack, MonadIO m) => ByteString -> m Text
- codecUtilsMpeg4videoGetProfile :: (HasCallStack, MonadIO m) => ByteString -> m Text
- codecUtilsOpusCreateCaps :: (HasCallStack, MonadIO m) => Word32 -> Word8 -> Word8 -> Word8 -> Word8 -> Maybe (Ptr Word8) -> m Caps
- codecUtilsOpusCreateCapsFromHeader :: (HasCallStack, MonadIO m) => Buffer -> Maybe Buffer -> m Caps
- codecUtilsOpusCreateHeader :: (HasCallStack, MonadIO m) => Word32 -> Word8 -> Word8 -> Word8 -> Word8 -> Maybe (Ptr Word8) -> Word16 -> Int16 -> m Buffer
- codecUtilsOpusParseCaps :: (HasCallStack, MonadIO m) => Caps -> m (Bool, Word32, Word8, Word8, Word8, Word8, ByteString)
- codecUtilsOpusParseHeader :: (HasCallStack, MonadIO m) => Buffer -> m (Bool, Word32, Word8, Word8, Word8, Word8, ByteString, Word16, Int16)
- encodingListAllTargets :: (HasCallStack, MonadIO m) => Maybe Text -> m [EncodingTarget]
- encodingListAvailableCategories :: (HasCallStack, MonadIO m) => m [Text]
- installPluginsAsync :: (HasCallStack, MonadIO m) => [Text] -> Maybe InstallPluginsContext -> InstallPluginsResultFunc -> m InstallPluginsReturn
- installPluginsInstallationInProgress :: (HasCallStack, MonadIO m) => m Bool
- installPluginsSupported :: (HasCallStack, MonadIO m) => m Bool
- installPluginsSync :: (HasCallStack, MonadIO m) => [Text] -> Maybe InstallPluginsContext -> m InstallPluginsReturn
- isMissingPluginMessage :: (HasCallStack, MonadIO m) => Message -> m Bool
- missingDecoderInstallerDetailNew :: (HasCallStack, MonadIO m) => Caps -> m Text
- missingDecoderMessageNew :: (HasCallStack, MonadIO m, IsElement a) => a -> Caps -> m Message
- missingElementInstallerDetailNew :: (HasCallStack, MonadIO m) => Text -> m Text
- missingElementMessageNew :: (HasCallStack, MonadIO m, IsElement a) => a -> Text -> m Message
- missingEncoderInstallerDetailNew :: (HasCallStack, MonadIO m) => Caps -> m Text
- missingEncoderMessageNew :: (HasCallStack, MonadIO m, IsElement a) => a -> Caps -> m Message
- missingPluginMessageGetDescription :: (HasCallStack, MonadIO m) => Message -> m Text
- missingPluginMessageGetInstallerDetail :: (HasCallStack, MonadIO m) => Message -> m Text
- missingUriSinkInstallerDetailNew :: (HasCallStack, MonadIO m) => Text -> m Text
- missingUriSinkMessageNew :: (HasCallStack, MonadIO m, IsElement a) => a -> Text -> m Message
- missingUriSourceInstallerDetailNew :: (HasCallStack, MonadIO m) => Text -> m Text
- missingUriSourceMessageNew :: (HasCallStack, MonadIO m, IsElement a) => a -> Text -> m Message
- pbUtilsAddCodecDescriptionToTagList :: (HasCallStack, MonadIO m) => TagList -> Maybe Text -> Caps -> m Bool
- pbUtilsGetCodecDescription :: (HasCallStack, MonadIO m) => Caps -> m Text
- pbUtilsGetDecoderDescription :: (HasCallStack, MonadIO m) => Caps -> m Text
- pbUtilsGetElementDescription :: (HasCallStack, MonadIO m) => Text -> m Text
- pbUtilsGetEncoderDescription :: (HasCallStack, MonadIO m) => Caps -> m Text
- pbUtilsGetSinkDescription :: (HasCallStack, MonadIO m) => Text -> m Text
- pbUtilsGetSourceDescription :: (HasCallStack, MonadIO m) => Text -> m Text
- pbUtilsInit :: (HasCallStack, MonadIO m) => m ()
- pluginsBaseVersion :: (HasCallStack, MonadIO m) => m (Word32, Word32, Word32, Word32)
- pluginsBaseVersionString :: (HasCallStack, MonadIO m) => m Text
Methods
codecUtilsAacCapsSetLevelAndProfile
codecUtilsAacCapsSetLevelAndProfile Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> ByteString |
|
-> m Bool | Returns: |
Sets the level and profile on caps
if it can be determined from
audioConfig
. See codecUtilsAacGetLevel
and
codecUtilsAacGetProfile
for more details on the parameters.
caps
must be audio/mpeg caps with an "mpegversion" field of either 2 or 4.
If mpegversion is 4, the "base-profile" field is also set in caps
.
codecUtilsAacGetChannels
codecUtilsAacGetChannels Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Word32 | Returns: The channels or 0 if the channel could not be determined. Since 1.10 |
Returns the channels of the given AAC stream.
codecUtilsAacGetIndexFromSampleRate
codecUtilsAacGetIndexFromSampleRate Source #
:: (HasCallStack, MonadIO m) | |
=> Word32 |
|
-> m Int32 | Returns: The AAC index for this sample rate, -1 if the rate is not a valid AAC sample rate. |
Translates the sample rate to the index corresponding to it in AAC spec.
codecUtilsAacGetLevel
codecUtilsAacGetLevel Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Text | Returns: The level as a const string and |
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 audioConfig
parameter follows the following format, starting from the
most significant bit of the first byte:
- Bit 0:4 contains the AudioObjectType (if this is 0x5, then the real AudioObjectType is carried after the rate and channel data)
- Bit 5:8 contains the sample frequency index (if this is 0xf, then the next 24 bits define the actual sample frequency, and subsequent fields are appropriately shifted).
- Bit 9:12 contains the channel configuration
codecUtilsAacGetProfile
codecUtilsAacGetProfile Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Text | Returns: The profile as a const string and |
Returns the profile of the given AAC stream as a string. The profile is
normally determined using the AudioObjectType field which is in the first
5 bits of audioConfig
codecUtilsAacGetSampleRate
codecUtilsAacGetSampleRate Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Word32 | Returns: The sample rate if sr_idx is valid, 0 otherwise. Since 1.10 |
Translates the sample rate index found in AAC headers to the actual sample rate.
codecUtilsAacGetSampleRateFromIndex
codecUtilsAacGetSampleRateFromIndex Source #
:: (HasCallStack, MonadIO m) | |
=> Word32 |
|
-> m Word32 | Returns: The sample rate if |
Translates the sample rate index found in AAC headers to the actual sample rate.
codecUtilsH264CapsSetLevelAndProfile
codecUtilsH264CapsSetLevelAndProfile Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> ByteString |
|
-> m Bool | Returns: |
Sets the level and profile in caps
if it can be determined from sps
. See
codecUtilsH264GetLevel
and codecUtilsH264GetProfile
for more details on the parameters.
codecUtilsH264GetLevel
codecUtilsH264GetLevel Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Text | Returns: The level as a const string, or |
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 codecUtilsH264GetProfile
.
codecUtilsH264GetLevelIdc
codecUtilsH264GetLevelIdc Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Word8 | Returns: the level_idc or 0 if the level is unknown |
Transform a level string from the caps into the level_idc
codecUtilsH264GetProfile
codecUtilsH264GetProfile Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Text | Returns: The profile as a const string, or |
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.
- Bit 0:7 - Profile indication
- Bit 8 - constraint_set0_flag
- Bit 9 - constraint_set1_flag
- Bit 10 - constraint_set2_flag
- Bit 11 - constraint_set3_flag
- Bit 12 - constraint_set3_flag
- Bit 13:15 - Reserved
- Bit 16:24 - Level indication
codecUtilsH265CapsSetLevelTierAndProfile
codecUtilsH265CapsSetLevelTierAndProfile Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> ByteString |
|
-> m Bool | Returns: Since 1.4 |
Sets the level, tier and profile in caps
if it can be determined from
profileTierLevel
. See codecUtilsH265GetLevel
,
codecUtilsH265GetTier
and codecUtilsH265GetProfile
for more details on the parameters.
codecUtilsH265GetLevel
codecUtilsH265GetLevel Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Text | Returns: The level as a const string, or Since 1.4 |
Converts the level indication (general_level_idc) in the stream's
profile_tier_level structure into a string. The profiel_tier_level is
expected to have the same format as for codecUtilsH264GetProfile
.
codecUtilsH265GetLevelIdc
codecUtilsH265GetLevelIdc Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Word8 | Returns: the level_idc or 0 if the level is unknown Since 1.4 |
Transform a level string from the caps into the level_idc
codecUtilsH265GetProfile
codecUtilsH265GetProfile Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Text | Returns: The profile as a const string, or Since 1.4 |
Converts the profile indication (general_profile_idc) in the stream's profile_level_tier structure into a string. The profile_tier_level is expected to have the following format, as defined in the H.265 specification. The profile_tier_level is viewed as a bitstream here, with bit 0 being the most significant bit of the first byte.
- Bit 0:1 - general_profile_space
- Bit 2 - general_tier_flag
- Bit 3:7 - general_profile_idc
- Bit 8:39 - gernal_profile_compatibility_flags
- Bit 40 - general_progressive_source_flag
- Bit 41 - general_interlaced_source_flag
- Bit 42 - general_non_packed_constraint_flag
- Bit 43 - general_frame_only_constraint_flag
- Bit 44:87 - general_reserved_zero_44bits
- Bit 88:95 - general_level_idc
codecUtilsH265GetTier
codecUtilsH265GetTier Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Text | Returns: The tier as a const string, or Since 1.4 |
Converts the tier indication (general_tier_flag) in the stream's
profile_tier_level structure into a string. The profile_tier_level
is expected to have the same format as for codecUtilsH264GetProfile
.
codecUtilsMpeg4videoCapsSetLevelAndProfile
codecUtilsMpeg4videoCapsSetLevelAndProfile Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> ByteString |
|
-> m Bool | Returns: |
Sets the level and profile in caps
if it can be determined from
visObjSeq
. See codecUtilsMpeg4videoGetLevel
and
codecUtilsMpeg4videoGetProfile
for more details on the
parameters.
codecUtilsMpeg4videoGetLevel
codecUtilsMpeg4videoGetLevel Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Text | Returns: The level as a const string, or NULL if there is an error. |
Converts the level indication in the stream's visual object sequence into
a string. visObjSeq
is expected to be the data following the visual
object sequence start code. Only the first byte
(profile_and_level_indication) is used.
codecUtilsMpeg4videoGetProfile
codecUtilsMpeg4videoGetProfile Source #
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m Text | Returns: The profile as a const string, or NULL if there is an error. |
Converts the profile indication in the stream's visual object sequence into
a string. visObjSeq
is expected to be the data following the visual
object sequence start code. Only the first byte
(profile_and_level_indication) is used.
codecUtilsOpusCreateCaps
codecUtilsOpusCreateCaps Source #
:: (HasCallStack, MonadIO m) | |
=> Word32 |
|
-> Word8 |
|
-> Word8 |
|
-> Word8 |
|
-> Word8 |
|
-> Maybe (Ptr Word8) |
|
-> m Caps | Returns: The |
Creates Opus caps from the given parameters.
Since: 1.8
codecUtilsOpusCreateCapsFromHeader
codecUtilsOpusCreateCapsFromHeader Source #
:: (HasCallStack, MonadIO m) | |
=> Buffer |
|
-> Maybe Buffer |
|
-> m Caps | Returns: The |
Creates Opus caps from the given OpusHead header
and comment header
comments
.
Since: 1.8
codecUtilsOpusCreateHeader
codecUtilsOpusCreateHeader Source #
:: (HasCallStack, MonadIO m) | |
=> Word32 |
|
-> Word8 |
|
-> Word8 |
|
-> Word8 |
|
-> Word8 |
|
-> Maybe (Ptr Word8) |
|
-> Word16 |
|
-> Int16 |
|
-> m Buffer | Returns: The |
Creates OpusHead header from the given parameters.
Since: 1.8
codecUtilsOpusParseCaps
codecUtilsOpusParseCaps Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> m (Bool, Word32, Word8, Word8, Word8, Word8, ByteString) |
Parses Opus caps and fills the different fields with defaults if possible.
Since: 1.8
codecUtilsOpusParseHeader
codecUtilsOpusParseHeader Source #
:: (HasCallStack, MonadIO m) | |
=> Buffer |
|
-> m (Bool, Word32, Word8, Word8, Word8, Word8, ByteString, Word16, Int16) |
Parses the OpusHead header.
Since: 1.8
encodingListAllTargets
encodingListAllTargets Source #
:: (HasCallStack, MonadIO m) | |
=> Maybe Text |
|
-> m [EncodingTarget] | Returns: The list of |
List all available EncodingTarget
for the specified category, or all categories
if categoryname
is Nothing
.
encodingListAvailableCategories
encodingListAvailableCategories Source #
:: (HasCallStack, MonadIO m) | |
=> m [Text] | Returns: A list
of |
Lists all EncodingTarget
categories present on disk.
installPluginsAsync
:: (HasCallStack, MonadIO m) | |
=> [Text] |
|
-> Maybe InstallPluginsContext |
|
-> InstallPluginsResultFunc |
|
-> m InstallPluginsReturn | Returns: result code whether an external installer could be started |
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 userData
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 missingPluginMessageGetInstallerDetail
on missing-plugin
messages that have been caught on a pipeline's bus or created by the
application via the provided API, such as missingElementMessageNew
.
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).
installPluginsInstallationInProgress
installPluginsInstallationInProgress Source #
:: (HasCallStack, MonadIO m) | |
=> m Bool | Returns: TRUE if plugin installation is in progress, otherwise FALSE |
Checks whether plugin installation (initiated by this application only) is currently in progress.
installPluginsSupported
installPluginsSupported Source #
:: (HasCallStack, MonadIO m) | |
=> m Bool | Returns: TRUE if plugin installation is likely to be 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.
installPluginsSync
:: (HasCallStack, MonadIO m) | |
=> [Text] |
|
-> Maybe InstallPluginsContext |
|
-> m InstallPluginsReturn | Returns: the result of the installation. |
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
installPluginsAsync
instead of this function.
isMissingPluginMessage
isMissingPluginMessage Source #
:: (HasCallStack, MonadIO m) | |
=> Message |
|
-> m Bool | Returns: |
Checks whether msg
is a missing plugins message.
missingDecoderInstallerDetailNew
missingDecoderInstallerDetailNew Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> m Text | Returns: a newly-allocated detail string, or NULL on error. Free string
with |
Returns an opaque string containing all the details about the missing
element to be passed to an external installer called via
installPluginsAsync
or installPluginsSync
.
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.
missingDecoderMessageNew
missingDecoderMessageNew Source #
:: (HasCallStack, MonadIO m, IsElement a) | |
=> a |
|
-> Caps |
|
-> m Message | Returns: a new |
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.
missingElementInstallerDetailNew
missingElementInstallerDetailNew Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Text | Returns: a newly-allocated detail string, or NULL on error. Free string
with |
Returns an opaque string containing all the details about the missing
element to be passed to an external installer called via
installPluginsAsync
or installPluginsSync
.
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.
missingElementMessageNew
missingElementMessageNew Source #
:: (HasCallStack, MonadIO m, IsElement a) | |
=> a |
|
-> Text |
|
-> m Message | Returns: a new |
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.
missingEncoderInstallerDetailNew
missingEncoderInstallerDetailNew Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> m Text | Returns: a newly-allocated detail string, or NULL on error. Free string
with |
Returns an opaque string containing all the details about the missing
element to be passed to an external installer called via
installPluginsAsync
or installPluginsSync
.
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.
missingEncoderMessageNew
missingEncoderMessageNew Source #
:: (HasCallStack, MonadIO m, IsElement a) | |
=> a |
|
-> Caps |
|
-> m Message | Returns: a new |
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.
missingPluginMessageGetDescription
missingPluginMessageGetDescription Source #
:: (HasCallStack, MonadIO m) | |
=> Message |
|
-> m Text | Returns: a newly-allocated description string, or NULL on error. Free
string with |
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
missingPluginMessageGetInstallerDetail
missingPluginMessageGetInstallerDetail Source #
:: (HasCallStack, MonadIO m) | |
=> Message |
|
-> m Text | Returns: a newly-allocated detail string, or NULL on error. Free string
with |
Returns an opaque string containing all the details about the missing
element to be passed to an external installer called via
installPluginsAsync
or installPluginsSync
.
This function is mainly for applications that call external plugin installation mechanisms using one of the two above-mentioned functions.
missingUriSinkInstallerDetailNew
missingUriSinkInstallerDetailNew Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Text | Returns: a newly-allocated detail string, or NULL on error. Free string
with |
Returns an opaque string containing all the details about the missing
element to be passed to an external installer called via
installPluginsAsync
or installPluginsSync
.
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.
missingUriSinkMessageNew
missingUriSinkMessageNew Source #
:: (HasCallStack, MonadIO m, IsElement a) | |
=> a |
|
-> Text |
|
-> m Message | Returns: a new |
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.
missingUriSourceInstallerDetailNew
missingUriSourceInstallerDetailNew Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Text | Returns: a newly-allocated detail string, or NULL on error. Free string
with |
Returns an opaque string containing all the details about the missing
element to be passed to an external installer called via
installPluginsAsync
or installPluginsSync
.
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.
missingUriSourceMessageNew
missingUriSourceMessageNew Source #
:: (HasCallStack, MonadIO m, IsElement a) | |
=> a |
|
-> Text |
|
-> m Message | Returns: a new |
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.
pbUtilsAddCodecDescriptionToTagList
pbUtilsAddCodecDescriptionToTagList Source #
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Maybe Text |
|
-> Caps |
|
-> m Bool | Returns: TRUE if a codec tag was added, FALSE otherwise. |
Adds a codec tag describing the format specified by caps
to taglist
.
pbUtilsGetCodecDescription
pbUtilsGetCodecDescription Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> m Text | Returns: a newly-allocated description string, or NULL on error. Free
string with |
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
pbUtilsAddCodecDescriptionToTagList
.
pbUtilsGetDecoderDescription
pbUtilsGetDecoderDescription Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> m Text | Returns: a newly-allocated description string, or NULL on error. Free
string with |
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 factoryName
or caps
are invalid.
This function is mainly for internal use, applications would typically
use missingPluginMessageGetDescription
to get a description of
a missing feature from a missing-plugin message.
pbUtilsGetElementDescription
pbUtilsGetElementDescription Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Text | Returns: a newly-allocated description string, or NULL on error. Free
string with |
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 factoryName
is invalid.
This function is mainly for internal use, applications would typically
use missingPluginMessageGetDescription
to get a description of
a missing feature from a missing-plugin message.
pbUtilsGetEncoderDescription
pbUtilsGetEncoderDescription Source #
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> m Text | Returns: a newly-allocated description string, or NULL on error. Free
string with |
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 factoryName
or caps
are invalid.
This function is mainly for internal use, applications would typically
use missingPluginMessageGetDescription
to get a description of
a missing feature from a missing-plugin message.
pbUtilsGetSinkDescription
pbUtilsGetSinkDescription Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Text | Returns: a newly-allocated description string, or NULL on error. Free
string with |
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 missingPluginMessageGetDescription
to get a description of
a missing feature from a missing-plugin message.
pbUtilsGetSourceDescription
pbUtilsGetSourceDescription Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Text | Returns: a newly-allocated description string, or NULL on error. Free
string with |
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 missingPluginMessageGetDescription
to get a description of
a missing feature from a missing-plugin message.
pbUtilsInit
pbUtilsInit :: (HasCallStack, MonadIO m) => m () Source #
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.
pluginsBaseVersion
pluginsBaseVersion :: (HasCallStack, MonadIO m) => m (Word32, Word32, Word32, Word32) Source #
Gets the version number of the GStreamer Plugins Base libraries.
pluginsBaseVersionString
pluginsBaseVersionString Source #
:: (HasCallStack, MonadIO m) | |
=> m Text | Returns: a newly allocated string describing this version of gst-plugins-base |
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 ...