GI.GstAudio.Interfaces.StreamVolume

This interface is implemented by elements that provide a stream volume. Examples for such elements are volume and playbin.

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.

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.

Exported types

newtype StreamVolume

Constructors

StreamVolume (ManagedPtr StreamVolume)

Instances

GObject StreamVolume

Methods

gobjectType :: StreamVolume -> IO GType

IsObject StreamVolume

IsStreamVolume StreamVolume

noStreamVolume :: Maybe StreamVolume

class GObject o => IsStreamVolume o

Instances

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

IsStreamVolume StreamVolume

toStreamVolume :: (MonadIO m, IsStreamVolume o) => o -> m 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

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

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

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

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

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

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

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

volume

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

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

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