#include "asterisk/channel.h"
#include "asterisk/frame.h"
#include <fcntl.h>
Include dependency graph for file.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Defines | |
| #define | AST_DIGIT_ANY "0123456789#*ABCD" |
| #define | AST_DIGIT_ANYNUM "0123456789" |
| #define | AST_RESERVED_POINTERS 20 |
| #define | SEEK_FORCECUR 10 |
Functions | |
| int | ast_applystream (struct ast_channel *chan, struct ast_filestream *s) |
| int | ast_closestream (struct ast_filestream *f) |
| int | ast_file_init (void) |
| int | ast_filecopy (const char *oldname, const char *newname, const char *fmt) |
| int | ast_filedelete (const char *filename, const char *fmt) |
| int | ast_fileexists (const char *filename, const char *fmt, const char *preflang) |
| int | ast_filerename (const char *oldname, const char *newname, const char *fmt) |
| int | ast_format_register (const char *name, const char *exts, int format, struct ast_filestream *(*open)(FILE *f), struct ast_filestream *(*rewrite)(FILE *f, const char *comment), int(*write)(struct ast_filestream *, struct ast_frame *), int(*seek)(struct ast_filestream *, long offset, int whence), int(*trunc)(struct ast_filestream *), long(*tell)(struct ast_filestream *), struct ast_frame *(*read)(struct ast_filestream *, int *timetonext), void(*close)(struct ast_filestream *), char *(*getcomment)(struct ast_filestream *)) |
| int | ast_format_unregister (const char *name) |
| ast_filestream * | ast_openstream (struct ast_channel *chan, const char *filename, const char *preflang) |
| ast_filestream * | ast_openstream_full (struct ast_channel *chan, const char *filename, const char *preflang, int asis) |
| ast_filestream * | ast_openvstream (struct ast_channel *chan, const char *filename, const char *preflang) |
| int | ast_playstream (struct ast_filestream *s) |
| ast_filestream * | ast_readfile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode) |
| ast_frame * | ast_readframe (struct ast_filestream *s) |
| int | ast_seekstream (struct ast_filestream *fs, long sample_offset, int whence) |
| int | ast_stopstream (struct ast_channel *c) |
| int | ast_stream_fastforward (struct ast_filestream *fs, long ms) |
| int | ast_stream_rewind (struct ast_filestream *fs, long ms) |
| int | ast_streamfile (struct ast_channel *c, const char *filename, const char *preflang) |
| long | ast_tellstream (struct ast_filestream *fs) |
| int | ast_truncstream (struct ast_filestream *fs) |
| int | ast_waitstream (struct ast_channel *c, const char *breakon) |
| int | ast_waitstream_exten (struct ast_channel *c, const char *context) |
| int | ast_waitstream_fr (struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms) |
| int | ast_waitstream_full (struct ast_channel *c, const char *breakon, int audiofd, int monfd) |
| ast_filestream * | ast_writefile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode) |
| int | ast_writestream (struct ast_filestream *fs, struct ast_frame *f) |
Definition in file file.h.
| #define AST_DIGIT_ANY "0123456789#*ABCD" |
| int ast_applystream | ( | struct ast_channel * | chan, | |
| struct ast_filestream * | s | |||
| ) |
| chan | channel to work | |
| s | ast_filestream to apply Returns 0 for success, -1 on failure |
| int ast_closestream | ( | struct ast_filestream * | f | ) |
| f | filestream to close Close a playback or recording stream Returns 0 on success, -1 on failure |
| int ast_file_init | ( | void | ) |
Initializes all the various file stuff. Basically just registers the cli stuff Returns 0 all the time
| int ast_filecopy | ( | const char * | oldname, | |
| const char * | newname, | |||
| const char * | fmt | |||
| ) |
| oldname | name of the file you wish to copy (minus extension) | |
| newname | name you wish the file to be copied to (minus extension) | |
| fmt | the format of the file Copy a given file in a given format, or if fmt is NULL, then do so for all |
| int ast_filedelete | ( | const char * | filename, | |
| const char * | fmt | |||
| ) |
| filename | name of the file you wish to delete (minus the extension) | |
| fmt | of the file Delete a given file in a given format, or if fmt is NULL, then do so for all |
| int ast_fileexists | ( | const char * | filename, | |
| const char * | fmt, | |||
| const char * | preflang | |||
| ) |
| filename | name of the file you wish to check, minus the extension | |
| fmt | the format you wish to check (the extension) | |
| preflang | (the preferred language you wisht to find the file in) See if a given file exists in a given format. If fmt is NULL, any format is accepted. Returns -1 if file does not exist, non-zero positive otherwise. |
| int ast_filerename | ( | const char * | oldname, | |
| const char * | newname, | |||
| const char * | fmt | |||
| ) |
| oldname | the name of the file you wish to act upon (minus the extension) | |
| newname | the name you wish to rename the file to (minus the extension) | |
| fmt | the format of the file Rename a given file in a given format, or if fmt is NULL, then do so for all Returns -1 on failure |
| int ast_format_register | ( | const char * | name, | |
| const char * | exts, | |||
| int | format, | |||
| struct ast_filestream *(*)(FILE *f) | open, | |||
| struct ast_filestream *(*)(FILE *f, const char *comment) | rewrite, | |||
| int(*)(struct ast_filestream *, struct ast_frame *) | write, | |||
| int(*)(struct ast_filestream *, long offset, int whence) | seek, | |||
| int(*)(struct ast_filestream *) | trunc, | |||
| long(*)(struct ast_filestream *) | tell, | |||
| struct ast_frame *(*)(struct ast_filestream *, int *timetonext) | read, | |||
| void(*)(struct ast_filestream *) | close, | |||
| char *(*)(struct ast_filestream *) | getcomment | |||
| ) |
Register a new file format capability Adds a format to asterisk's format abilities. Fill in the fields, and it will work. For examples, look at some of the various format code. returns 0 on success, -1 on failure
| int ast_format_unregister | ( | const char * | name | ) |
| name | the name of the format you wish to unregister Unregisters a format based on the name of the format. Returns 0 on success, -1 on failure to unregister |
| struct ast_filestream* ast_openstream | ( | struct ast_channel * | chan, | |
| const char * | filename, | |||
| const char * | preflang | |||
| ) |
| chan | channel to work with | |
| filename | to use | |
| preflang | prefered language to use Returns a ast_filestream pointer if it opens the file, NULL on error |
| struct ast_filestream* ast_openstream_full | ( | struct ast_channel * | chan, | |
| const char * | filename, | |||
| const char * | preflang, | |||
| int | asis | |||
| ) |
| chan | channel to work with | |
| filename | to use | |
| preflang | prefered language to use | |
| asis | if set, don't clear generators Returns a ast_filestream pointer if it opens the file, NULL on error |
| struct ast_filestream* ast_openvstream | ( | struct ast_channel * | chan, | |
| const char * | filename, | |||
| const char * | preflang | |||
| ) |
| chan | channel to work with | |
| filename | to use | |
| preflang | prefered language to use Returns a ast_filestream pointer if it opens the file, NULL on error |
| int ast_playstream | ( | struct ast_filestream * | s | ) |
| s | filestream to play Returns 0 for success, -1 on failure |
| struct ast_filestream* ast_readfile | ( | const char * | filename, | |
| const char * | type, | |||
| const char * | comment, | |||
| int | flags, | |||
| int | check, | |||
| mode_t | mode | |||
| ) |
| filename | the name of the file to read from | |
| type | format of file you wish to read from | |
| comment | comment to go with | |
| flags | file flags | |
| check | (unimplemented, hence negligible) | |
| mode | Open mode Open an incoming file stream. flags are flags for the open() command, and if check is non-zero, then it will not read a file if there are any files that start with that name and have an extension Please note, this is a blocking function. Program execution will not return until ast_waitstream completes it's execution. Returns a struct ast_filestream on success, NULL on failure |
| struct ast_frame* ast_readframe | ( | struct ast_filestream * | s | ) |
| s | ast_filestream to act on Returns a frame or NULL if read failed |
| int ast_seekstream | ( | struct ast_filestream * | fs, | |
| long | sample_offset, | |||
| int | whence | |||
| ) |
| fs | ast_filestream to perform seek on | |
| sample_offset | numbers of samples to seek | |
| whence | SEEK_SET, SEEK_CUR, SEEK_END Returns 0 for success, or -1 for error |
| int ast_stopstream | ( | struct ast_channel * | c | ) |
| c | The channel you wish to stop playback on Stop playback of a stream Returns 0 regardless |
| int ast_stream_fastforward | ( | struct ast_filestream * | fs, | |
| long | ms | |||
| ) |
| fs | filestream to act on | |
| ms | milliseconds to move Returns 0 for success, or -1 for error |
| int ast_stream_rewind | ( | struct ast_filestream * | fs, | |
| long | ms | |||
| ) |
| fs | filestream to act on | |
| ms | milliseconds to move Returns 0 for success, or -1 for error |
| int ast_streamfile | ( | struct ast_channel * | c, | |
| const char * | filename, | |||
| const char * | preflang | |||
| ) |
| c | channel to stream the file to | |
| filename | the name of the file you wish to stream, minus the extension | |
| preflang | the preferred language you wish to have the file streamed to you in Prepares a channel for the streaming of a file. To start the stream, afterward do a ast_waitstream() on the channel Also, it will stop any existing streams on the channel. Returns 0 on success, or -1 on failure. |
| long ast_tellstream | ( | struct ast_filestream * | fs | ) |
| fs | fs to act on Returns a long as a sample offset into stream |
| int ast_truncstream | ( | struct ast_filestream * | fs | ) |
| fs | filestream to act on Returns 0 for success, or -1 for error |
| int ast_waitstream | ( | struct ast_channel * | c, | |
| const char * | breakon | |||
| ) |
| c | channel to waitstram on | |
| breakon | string of DTMF digits to break upon Begins playback of a stream... Wait for a stream to stop or for any one of a given digit to arrive, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error |
| int ast_waitstream_exten | ( | struct ast_channel * | c, | |
| const char * | context | |||
| ) |
| c | channel to waitstram on | |
| context | string of context to match digits to break upon Begins playback of a stream... Wait for a stream to stop or for any one of a valid extension digit to arrive, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error |
| int ast_waitstream_fr | ( | struct ast_channel * | c, | |
| const char * | breakon, | |||
| const char * | forward, | |||
| const char * | rewind, | |||
| int | ms | |||
| ) |
| c | channel to waitstram on | |
| breakon | string of DTMF digits to break upon | |
| forward | DTMF digit to fast forward upon | |
| rewind | DTMF digit to rewind upon | |
| ms | How many miliseconds to skip forward/back Begins playback of a stream... Wait for a stream to stop or for any one of a given digit to arrive, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error |
| struct ast_filestream* ast_writefile | ( | const char * | filename, | |
| const char * | type, | |||
| const char * | comment, | |||
| int | flags, | |||
| int | check, | |||
| mode_t | mode | |||
| ) |
| filename | the name of the file to write to | |
| type | format of file you wish to write out to | |
| comment | comment to go with | |
| flags | output file flags | |
| check | (unimplemented, hence negligible) | |
| mode | Open mode Create an outgoing file stream. oflags are flags for the open() command, and if check is non-zero, then it will not write a file if there are any files that start with that name and have an extension Please note, this is a blocking function. Program execution will not return until ast_waitstream completes it's execution. Returns a struct ast_filestream on success, NULL on failure |
| int ast_writestream | ( | struct ast_filestream * | fs, | |
| struct ast_frame * | f | |||
| ) |
| fs | filestream to write to | |
| f | frame to write to the filestream Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually Returns 0 on success, -1 on failure. |
1.5.1