Changeset 4605:8f0e515e61a6 in roaraudio


Ignore:
Timestamp:
11/15/10 17:10:00 (13 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

typos

File:
1 edited

Legend:

Unmodified
Added
Removed
  • include/libroar/vs.h

    r4580 r4605  
    3030 *  or libpulse*: 
    3131 *  The libs libroaresd, libroararts and libroarpulse link this lib 
    32  *  and are therefore GPL. Because of this it may be illigal to use 
     32 *  and are therefore GPL. Because of this it may be illegal to use 
    3333 *  them with any software that uses libesd, libartsc or libpulse*. 
    3434 */ 
     
    4444typedef signed long int roar_mus_t; 
    4545 
    46 /* return readable string descriping the problem */ 
     46/* return readable string describing the problem */ 
    4747const char * roar_vs_strerr(int error); 
    4848 
     
    6060 
    6161/* connect to server and start stream in once 
    62  * this is basicly roar_vs_new() and roar_vs_stream() in one function. 
     62 * this is basically roar_vs_new() and roar_vs_stream() in one function. 
    6363 */ 
    6464roar_vs_t * roar_vs_new_simple(const char * server, const char * name, int rate, int channels, int codec, int bits, int dir, int * error); 
     
    9595 * This does all needed cleanup. 
    9696 * If server connection was made by VS it is closed, too. 
    97  * If server connectionw as provided by caller it is untouched. 
     97 * If server connection was provided by caller it is untouched. 
    9898 */ 
    9999int roar_vs_close(roar_vs_t * vss, int killit, int * error); 
     
    102102 * This function writes some data to the stream. 
    103103 * return is number of bytes written or -1 on error. 
    104  * return value can be zero to intercate no data can be written but no error. 
     104 * return value can be zero to indicate no data can be written but no error. 
    105105 * this may be the case with non-blocking streams. 
    106  * retruned value can be less then requested value. indecates a short write. 
    107  * you should wait some (short!) time (for example one main loop interation) and try again. 
     106 * returned value can be less then requested value. indicates a short write. 
     107 * you should wait some (short!) time (for example one main loop iteration) and try again. 
    108108 */ 
    109109ssize_t roar_vs_write(roar_vs_t * vss, const void * buf, size_t len, int * error); 
     
    112112 * This function reads some data from the stream. 
    113113 * return is number of bytes read or -1 on error. 
    114  * return value can be zero to intercate no data can be read but no error. 
     114 * return value can be zero to indicate no data can be read but no error. 
    115115 * this may be the case with non-blocking streams. 
    116  * retruned value can be less then requested value. indecates a short read. 
    117  * you should wait some (short!) time (for example one main loop interation) and try again. 
     116 * returned value can be less then requested value. indicates a short read. 
     117 * you should wait some (short!) time (for example one main loop iteration) and try again. 
    118118 */ 
    119119ssize_t roar_vs_read (roar_vs_t * vss,       void * buf, size_t len, int * error); 
     
    138138/* do not supply backend offset */ 
    139139#define ROAR_VS_BACKEND_NONE    -1 
    140 /* use first found primay stream of same mixer as offset source */ 
     140/* use first found primary stream of same mixer as offset source */ 
    141141#define ROAR_VS_BACKEND_FIRST   -2 
    142142/* use mean of primary streams of same mixer as offset source */ 
    143143#define ROAR_VS_BACKEND_MEAN    -3 
    144144 
    145 /* get server's possition of stream 
    146  * returns server's possition of the stream or -1 on error. 
    147  * The retruned server possition is the possition in samples 
     145/* get server's position of stream 
     146 * returns server's position of the stream or -1 on error. 
     147 * The returned server position is the position in samples 
    148148 * plus a offset provided by the selected backend 
    149149 */ 
     
    153153 * This function may fail because the used codec uses 
    154154 * non-fixed bitrate. 
    155  * if this function fails it retruns zero and sets error or 
     155 * if this function fails it returns zero and sets error or 
    156156 * clear error to ROAR_ERROR_NONE. 
    157  * If non-zero is retruned error is untouched. 
     157 * If non-zero is returned error is untouched. 
    158158 * return value is in mu-sec (units of 10^-6s). 
    159  * Note that the retruned value may be negative (the server being 
     159 * Note that the returned value may be negative (the server being 
    160160 * ahead of us). This is normal in case we read a stream. 
    161161 */ 
     
    163163 
    164164/* set pause flag 
    165  * The pause flag should be set whenever the user presses the pause button or simular. 
     165 * The pause flag should be set whenever the user presses the pause button or similar. 
    166166 * The stream may be come blocking after the pause flag has been set. 
    167  * returns old pause setting (usefull with ROAR_VS_TOGGLE) 
     167 * returns old pause setting (useful with ROAR_VS_TOGGLE) 
    168168 */ 
    169169int     roar_vs_pause(roar_vs_t * vss, int val, int * error); 
    170170 
    171171/* set the mute flag of the stream 
    172  * Thie pause flag should be set wehnever the user mutes the stream in some way. 
     172 * The pause flag should be set whenever the user mutes the stream in some way. 
    173173 * This flag is used so the volume is not changed and can be restored by the server 
    174174 * while unmuting. 
    175175 * It is very recommended to use this flag and not just set the volume to zero 
    176  * returns old mute setting (usefull with ROAR_VS_TOGGLE) 
     176 * returns old mute setting (useful with ROAR_VS_TOGGLE) 
    177177 */ 
    178178int     roar_vs_mute (roar_vs_t * vss, int val, int * error); 
     
    183183 */ 
    184184int     roar_vs_volume_mono   (roar_vs_t * vss, float c, int * error); 
    185 /* set volume of stream (like volume + ballance, stereo mode) 
     185/* set volume of stream (like volume + balance, stereo mode) 
    186186 * volume l and r are floats from 0 ('muted', see above) to 1 (full volume). 
    187187 * Returns 0 on no error and -1 on error. 
     
    189189int     roar_vs_volume_stereo (roar_vs_t * vss, float l, float r, int * error); 
    190190 
    191 /* get volume from stream (like volume + ballance, stereo mode) 
    192  * volume pinters l and r are floats from 0 ('muted', see above) to 1 (full volume). 
     191/* get volume from stream (like volume + balance, stereo mode) 
     192 * volume pointers l and r are floats from 0 ('muted', see above) to 1 (full volume). 
    193193 * Returns 0 on no error and -1 on error. 
    194194 * NOTE: if you want a 'mono' volume (like roar_vs_volume_mono() takes) 
     
    215215int     roar_vs_role          (roar_vs_t * vss, int role, int * error); 
    216216 
    217 /* Run a single interation. 
     217/* Run a single iteration. 
    218218 * This will try to read data from source, write it to the stream 
    219219 * and flush the buffer in buffered mode. 
     
    222222int     roar_vs_iterate       (roar_vs_t * vss, int wait, int * error); 
    223223 
    224 /* Iterate untill EOF or error. 
     224/* Iterate until EOF or error. 
    225225 * Very simple main loop. 
    226226 * Returns 0 on no error and -1 on error. 
     
    229229 
    230230/* Get used connection object 
    231  * This may be usefull if you want to use functions from the main API. 
     231 * This may be useful if you want to use functions from the main API. 
    232232 * Returns used connection object or NULL on error. 
    233233 */ 
     
    235235 
    236236/* Get used stream object 
    237  * This may be usefull if you want to use functions from the main API. 
     237 * This may be useful if you want to use functions from the main API. 
    238238 * Returns used stream object or NULL on error. 
    239239 */ 
     
    241241 
    242242/* Get used VIO object 
    243  * This may be usefull if you want to use functions from the main API. 
     243 * This may be useful if you want to use functions from the main API. 
    244244 * For example this can be used in non-blocking mode 
    245245 * to test if we can read or write. To test that use roar_vio_select(). 
     
    250250/* send NOOP command to server 
    251251 * This can be used to ping the server. 
    252  * This is of no use normaly. 
     252 * This is of no use normally. 
    253253 * Returns 0 on no error and -1 on error. 
    254254 */ 
Note: See TracChangeset for help on using the changeset viewer.