AudioInputStop

From TrillWiki

The audioInputStop function will stop an audio stream which has been started with audioInputStart.

Compatibility: 3.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID,"audioInputStop",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

AudioInputStop utilitizes the audio_t structure.

struct audio_t 
{ 
    unsigned int                struct_size; 

    int                         connection_id;
    int                         window_id;

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

    char                        *section;

    int                         initiated;
    int                         ask_confirmation;

    /* Audio Information
     */

    int                         codec; 

    int                         audio_sample_size;
    int                         audio_sample_rate;
    int                         audio_block_size;
    int                         audio_quality;

    int                         audio_data_length; 

    unsigned char               *audio_data; 

    ttkCallback                 callback; 
    void                        *data; 
};

window_id

The window ID whose audio input stream is being shut down.

Return Value

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

Remarks

Once a stream has been stopped, you may either audioInputStart it again, or audioInputUninitialize it to get rid of it.