YGetPlaySoundObjectValues(3)

NAME

YGetPlaySoundObjectValues - get playing sound object values

SYNTAX

#include <Y2/Y.h>
#include <Y2/Ylib.h>

int YGetPlaySoundObjectValues(
        YConnection *connection,
        YID yid,
        YEventSoundPlay *value
)

ARGUMENTS

connection
    Specifies the connection to the Y server, obtained by a call to YOpenConnection.

yid Specifies the YID of the playing instance of the sound object that you want to stop. This value should have been previously returned by a call to YStartPlaySoundObject or YStartPlaySoundObjectSimple.

value
    Specifies the buffer to store the values of the playing sound object. See YEventSoundPlay for more information about this structure.

DESCRIPTION

The YGetPlaySoundObjectValues gets the play values of a sound object already playing. The value of yid must be that of one recieved from a call to YStartPlaySoundObject or YStartPlaySoundObjectSimple.

RETURN VALUE

The YGetPlaySoundObjectValues returns 0 on success or non-zero on error.

EXAMPLE

#include <stdio.h>
#include <unistd.h>
#include <Y2/Y.h>
#include <Y2/Ylib.h>

int main(int argc, char *argv[])
{
        YID yid;
        YEventSoundPlay value;
        YConnection *con = YOpenConnection(
                "/usr/sbin/starty",
                "127.0.0.1:9433"
        );
        if(con == NULL)
                return(1);

        /* Start playing a sound object. */
        yid = YStartPlaySoundObjectSimple(
                con, "/usr/share/sounds/info.wav"
        );

        /* Get values of the playing sound object. */
        if(!YGetPlaySoundObjectValues(
                con, yid, &value
        ))
        {
                /* Handle values here. */
        }

        sleep(3);

        YDestroyPlaySoundObject(con, yid);

        YCloseConnection(con, False);

        return(0);
}

SEE ALSO

YStartPlaySoundObject(3) YGetSoundObjectAttributes(3) YDestroyPlaySoundObject(3)