Logo Search packages:      
Sourcecode: pulseaudio version File versions

Sink state.

Since:
0.9.15
Enumerator:
PA_SINK_INVALID_STATE  This state is used when the server does not support sink state introspection
Since:
0.9.15
PA_SINK_RUNNING  Running, sink is playing and used by at least one non-corked sink-input
Since:
0.9.15
PA_SINK_IDLE  When idle, the sink is playing but there is no non-corked sink-input attached to it
Since:
0.9.15
PA_SINK_SUSPENDED  When suspended, actual sink access can be closed, for instance
Since:
0.9.15

Definition at line 731 of file def.h.

                           { /* enum serialized in u8 */
    PA_SINK_INVALID_STATE = -1,
    /**< This state is used when the server does not support sink state introspection \since 0.9.15 */

    PA_SINK_RUNNING = 0,
    /**< Running, sink is playing and used by at least one non-corked sink-input \since 0.9.15 */

    PA_SINK_IDLE = 1,
    /**< When idle, the sink is playing but there is no non-corked sink-input attached to it \since 0.9.15 */

    PA_SINK_SUSPENDED = 2,
    /**< When suspended, actual sink access can be closed, for instance \since 0.9.15 */

/** \cond fulldocs */
    /* PRIVATE: Server-side values -- DO NOT USE THIS ON THE CLIENT
     * SIDE! These values are *not* considered part of the official PA
     * API/ABI. If you use them your application might break when PA
     * is upgraded. Also, please note that these values are not useful
     * on the client side anyway. */

    PA_SINK_INIT = -2,
    /**< Initialization state */

    PA_SINK_UNLINKED = -3
    /**< The state when the sink is getting unregistered and removed from client access */
/** \endcond */

} pa_sink_state_t;


Generated by  Doxygen 1.6.0   Back to index