Changeset 4635:a4aea883b1ff in roaraudio


Ignore:
Timestamp:
11/30/10 12:03:01 (11 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

added some more comments/help

File:
1 edited

Legend:

Unmodified
Added
Removed
  • include/libroar/vs.h

    r4629 r4635  
    8383roar_vs_t * roar_vs_new_from_file(const char * server, const char * name, char * filename, int * error); 
    8484 
     85/* Switch to buffered mode. 
     86 * After swiching to buffered mode you can use the buffered 
     87 * mode functions. You must use roar_vs_iterate() to send data 
     88 * from local buffer to server. 
     89 * This is currently not thread safe but you may implement it in 
     90 * diffrent thread if you do the locking yourself. 
     91 * Takes the size for the used buffers as argument. 
     92 * Buffer size should be a value of 2^n. Typical values are 2048 and 4096. 
     93 */ 
    8594int roar_vs_buffer(roar_vs_t * vss, size_t buffer, int * error); 
    8695 
     
    234243ssize_t roar_vs_get_avail_write(roar_vs_t * vss, int * error); 
    235244 
     245/* If in buffered mode drop all data from internal buffer. 
     246 * This drops all data in current ringbuffers. You can 
     247 * select if data is only droped in write or read buffer. 
     248 * This may be usefull in case of seeking and such 
     249 * but should be avoided as it may break the bitstream. 
     250 */ 
    236251int     roar_vs_reset_buffer(roar_vs_t * vss, int writering, int readring, int * error); 
    237252 
    238253/* Misc controls. 
     254 * Use of this should be avoided by application. 
    239255 */ 
    240256 
Note: See TracChangeset for help on using the changeset viewer.