AudioInputStatus

From TrillWiki

The audioInputStatus command allows you to set the status of a stream for UI purposes.

Compatibility: 3.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID,"audioInputStatus",audio_t *);

Note that all Trillian functions and notifications begin with a lower-case letter, despite the Wiki requirement that all pages start with a capital letter.

Parameters

AudioInputStatus utilitizes the audio_status_t structure.

struct audio_status_t
{
    unsigned int                struct_size;

    int                         connection_id;
    int                         window_id;

    char                        *medium;
    char                        *name;
    char                        *location;

    char                        *type;
    char                        *status;

    char                        *link;
    char                        *tooltip;
};

medium

The medium this audio stream is being hosted over.

connection_id

The connection with which this is associated.

name

The contact with which this chat is associated.

window_id

Optionally, the window ID with which this chat is associated. (If provided, you don't need the above things for looking it up.)

type

The type of status update. This can be 'activate_status', 'inactive_status', 'activating_status', 'muted', 'paused' or NULL. NULL means default status.

status

Optional status text which can be displayed as a UI element.

Return Value

This function returns 0 on success, or a negative value on error.

Remarks

None.