Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GI.Gst.Interfaces.URIHandler
Description
The URIHandler
is an interface that is implemented by Source and Sink
Element
to unify handling of URI.
An application can use the following functions to quickly get an element
that handles the given URI for reading or writing
(elementMakeFromUri
).
Source and Sink plugins should implement this interface when possible.
Synopsis
- newtype URIHandler = URIHandler (ManagedPtr URIHandler)
- class (ManagedPtrNewtype o, IsDescendantOf URIHandler o) => IsURIHandler o
- uRIHandlerGetProtocols :: (HasCallStack, MonadIO m, IsURIHandler a) => a -> m (Maybe [Text])
- uRIHandlerGetUri :: (HasCallStack, MonadIO m, IsURIHandler a) => a -> m (Maybe Text)
- uRIHandlerGetUriType :: (HasCallStack, MonadIO m, IsURIHandler a) => a -> m URIType
- uRIHandlerSetUri :: (HasCallStack, MonadIO m, IsURIHandler a) => a -> Text -> m ()
Exported types
newtype URIHandler Source #
Memory-managed wrapper type.
Constructors
URIHandler (ManagedPtr URIHandler) |
Instances
Eq URIHandler Source # | |
Defined in GI.Gst.Interfaces.URIHandler | |
BoxedPtr URIHandler Source # | |
Defined in GI.Gst.Interfaces.URIHandler | |
ManagedPtrNewtype URIHandler Source # | |
Defined in GI.Gst.Interfaces.URIHandler Methods |
class (ManagedPtrNewtype o, IsDescendantOf URIHandler o) => IsURIHandler o Source #
Type class for types which implement URIHandler
.
Instances
(ManagedPtrNewtype o, IsDescendantOf URIHandler o) => IsURIHandler o Source # | |
Defined in GI.Gst.Interfaces.URIHandler |
Methods
Click to display all available methods, including inherited ones
getProtocols
uRIHandlerGetProtocols Source #
Arguments
:: (HasCallStack, MonadIO m, IsURIHandler a) | |
=> a |
|
-> m (Maybe [Text]) | Returns: the
supported protocols. Returns |
Gets the list of protocols supported by handler
. This list may not be
modified.
getUri
Arguments
:: (HasCallStack, MonadIO m, IsURIHandler a) | |
=> a |
|
-> m (Maybe Text) | Returns: the URI currently handled by
the |
Gets the currently handled URI.
getUriType
Arguments
:: (HasCallStack, MonadIO m, IsURIHandler a) | |
=> a |
|
-> m URIType | Returns: the |
Gets the type of the given URI handler
setUri
Arguments
:: (HasCallStack, MonadIO m, IsURIHandler a) | |
=> a |
|
-> Text |
|
-> m () | (Can throw |
Tries to set the URI of the given handler.