GI.GstAudio.Interfaces.StreamVolume

<refsect2> <para> This interface is implemented by elements that provide a stream volume. Examples for such elements are volume and playbin. </para> <para> Applications can use this interface to get or set the current stream volume. For this the "volume" Object property can be used or the helper functions streamVolumeSetVolume and streamVolumeGetVolume. This volume is always a linear factor, i.e. 0.0 is muted 1.0 is 100%. For showing the volume in a GUI it might make sense to convert it to a different format by using streamVolumeConvertVolume. Volume sliders should usually use a cubic volume.

Separate from the volume the stream can also be muted by the "mute" Object property or streamVolumeSetMute and streamVolumeGetMute. </para> <para> Elements that provide some kind of stream volume should implement the "volume" and "mute" Object properties and handle setting and getting of them properly. The volume property is defined to be a linear volume factor. </para> </refsect2>

Exported types

newtype StreamVolume

Constructors

StreamVolume (ManagedPtr StreamVolume)

Instances

GObject StreamVolume

Methods

gobjectType :: StreamVolume -> IO GType

IsObject StreamVolume

IsStreamVolume StreamVolume

((~) * info (ResolveStreamVolumeMethod t StreamVolume), MethodInfo * info StreamVolume p) => IsLabel t (StreamVolume -> p)

Methods

fromLabel :: Proxy# Symbol t -> StreamVolume -> p

((~) * info (ResolveStreamVolumeMethod t StreamVolume), MethodInfo * info StreamVolume p) => IsLabelProxy t (StreamVolume -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> StreamVolume -> p

HasAttributeList * StreamVolume

type AttributeList StreamVolume

type AttributeList StreamVolume

type SignalList StreamVolume

type SignalList StreamVolume

noStreamVolume :: Maybe StreamVolume

class GObject o => IsStreamVolume o

Instances

(GObject a, UnknownAncestorError Constraint StreamVolume a) => IsStreamVolume a

IsStreamVolume StreamVolume

toStreamVolume :: IsStreamVolume o => o -> IO StreamVolume

Methods

convertVolume

streamVolumeConvertVolume

Arguments

:: (HasCallStack, MonadIO m)

=> StreamVolumeFormat

from: StreamVolumeFormat to convert from

-> StreamVolumeFormat

to: StreamVolumeFormat to convert to

-> Double

val: Volume in from format that should be converted

-> m Double

Returns: the converted volume

No description available in the introspection data.

getMute

data StreamVolumeGetMuteMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsStreamVolume a) => MethodInfo * StreamVolumeGetMuteMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StreamVolumeGetMuteMethodInfo a -> signature -> s

streamVolumeGetMute

Arguments

:: (HasCallStack, MonadIO m, IsStreamVolume a)

=> a

volume: StreamVolume that should be used

-> m Bool

Returns: Returns True if the stream is muted

No description available in the introspection data.

getVolume

data StreamVolumeGetVolumeMethodInfo

Instances

((~) * signature (StreamVolumeFormat -> m Double), MonadIO m, IsStreamVolume a) => MethodInfo * StreamVolumeGetVolumeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StreamVolumeGetVolumeMethodInfo a -> signature -> s

streamVolumeGetVolume

Arguments

:: (HasCallStack, MonadIO m, IsStreamVolume a)

=> a

volume: StreamVolume that should be used

-> StreamVolumeFormat

format: StreamVolumeFormat which should be returned

-> m Double

Returns: The current stream volume as linear factor

No description available in the introspection data.

setMute

data StreamVolumeSetMuteMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsStreamVolume a) => MethodInfo * StreamVolumeSetMuteMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StreamVolumeSetMuteMethodInfo a -> signature -> s

streamVolumeSetMute

Arguments

:: (HasCallStack, MonadIO m, IsStreamVolume a)

=> a

volume: StreamVolume that should be used

-> Bool

mute: Mute state that should be set

-> m ()

No description available in the introspection data.

setVolume

data StreamVolumeSetVolumeMethodInfo

Instances

((~) * signature (StreamVolumeFormat -> Double -> m ()), MonadIO m, IsStreamVolume a) => MethodInfo * StreamVolumeSetVolumeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StreamVolumeSetVolumeMethodInfo a -> signature -> s

streamVolumeSetVolume

Arguments

:: (HasCallStack, MonadIO m, IsStreamVolume a)

=> a

volume: StreamVolume that should be used

-> StreamVolumeFormat

format: StreamVolumeFormat of val

-> Double

val: Linear volume factor that should be set

-> m ()

No description available in the introspection data.

Properties

mute

data StreamVolumeMutePropertyInfo

Instances

AttrInfo StreamVolumeMutePropertyInfo

Associated Types

type AttrAllowedOps StreamVolumeMutePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint StreamVolumeMutePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint StreamVolumeMutePropertyInfo :: * -> Constraint

type AttrGetType StreamVolumeMutePropertyInfo :: *

type AttrLabel StreamVolumeMutePropertyInfo :: Symbol

type AttrOrigin StreamVolumeMutePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint StreamVolumeMutePropertyInfo o => Proxy * StreamVolumeMutePropertyInfo -> o -> IO (AttrGetType StreamVolumeMutePropertyInfo)

attrSet :: (AttrBaseTypeConstraint StreamVolumeMutePropertyInfo o, AttrSetTypeConstraint StreamVolumeMutePropertyInfo b) => Proxy * StreamVolumeMutePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint StreamVolumeMutePropertyInfo o => Proxy * StreamVolumeMutePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint StreamVolumeMutePropertyInfo o, AttrSetTypeConstraint StreamVolumeMutePropertyInfo b) => Proxy * StreamVolumeMutePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin StreamVolumeMutePropertyInfo

type AttrOrigin StreamVolumeMutePropertyInfo = StreamVolume

type AttrLabel StreamVolumeMutePropertyInfo

type AttrLabel StreamVolumeMutePropertyInfo = "mute"

type AttrGetType StreamVolumeMutePropertyInfo

type AttrGetType StreamVolumeMutePropertyInfo = Bool

type AttrBaseTypeConstraint StreamVolumeMutePropertyInfo

type AttrBaseTypeConstraint StreamVolumeMutePropertyInfo = IsStreamVolume

type AttrSetTypeConstraint StreamVolumeMutePropertyInfo

type AttrSetTypeConstraint StreamVolumeMutePropertyInfo = * ~ Bool

type AttrAllowedOps StreamVolumeMutePropertyInfo

type AttrAllowedOps StreamVolumeMutePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructStreamVolumeMute :: IsStreamVolume o => Bool -> IO (GValueConstruct o)

getStreamVolumeMute :: (MonadIO m, IsStreamVolume o) => o -> m Bool

setStreamVolumeMute :: (MonadIO m, IsStreamVolume o) => o -> Bool -> m ()

streamVolumeMute :: AttrLabelProxy "mute"

volume

data StreamVolumeVolumePropertyInfo

Instances

AttrInfo StreamVolumeVolumePropertyInfo

Associated Types

type AttrAllowedOps StreamVolumeVolumePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint StreamVolumeVolumePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint StreamVolumeVolumePropertyInfo :: * -> Constraint

type AttrGetType StreamVolumeVolumePropertyInfo :: *

type AttrLabel StreamVolumeVolumePropertyInfo :: Symbol

type AttrOrigin StreamVolumeVolumePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint StreamVolumeVolumePropertyInfo o => Proxy * StreamVolumeVolumePropertyInfo -> o -> IO (AttrGetType StreamVolumeVolumePropertyInfo)

attrSet :: (AttrBaseTypeConstraint StreamVolumeVolumePropertyInfo o, AttrSetTypeConstraint StreamVolumeVolumePropertyInfo b) => Proxy * StreamVolumeVolumePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint StreamVolumeVolumePropertyInfo o => Proxy * StreamVolumeVolumePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint StreamVolumeVolumePropertyInfo o, AttrSetTypeConstraint StreamVolumeVolumePropertyInfo b) => Proxy * StreamVolumeVolumePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin StreamVolumeVolumePropertyInfo

type AttrOrigin StreamVolumeVolumePropertyInfo = StreamVolume

type AttrLabel StreamVolumeVolumePropertyInfo

type AttrLabel StreamVolumeVolumePropertyInfo = "volume"

type AttrGetType StreamVolumeVolumePropertyInfo

type AttrGetType StreamVolumeVolumePropertyInfo = Double

type AttrBaseTypeConstraint StreamVolumeVolumePropertyInfo

type AttrBaseTypeConstraint StreamVolumeVolumePropertyInfo = IsStreamVolume

type AttrSetTypeConstraint StreamVolumeVolumePropertyInfo

type AttrSetTypeConstraint StreamVolumeVolumePropertyInfo = * ~ Double

type AttrAllowedOps StreamVolumeVolumePropertyInfo

type AttrAllowedOps StreamVolumeVolumePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructStreamVolumeVolume :: IsStreamVolume o => Double -> IO (GValueConstruct o)

getStreamVolumeVolume :: (MonadIO m, IsStreamVolume o) => o -> m Double

setStreamVolumeVolume :: (MonadIO m, IsStreamVolume o) => o -> Double -> m ()

streamVolumeVolume :: AttrLabelProxy "volume"