Prosody high level FILE play/record: API: sm_record_file_start

Prototype Definition

int sm_record_file_start(struct sm_file_record_parms *file_parms)

Parameters

*file_parms
a structure of the following type: 
typedef struct sm_file_record_parms {
	tSM_OPEN_FILE fd;					/* in */
	SM_RECORD_PARMS record_parms;				/* in */
	int status;						/* out */
	tSM_UT32 private_length;				/* out */
	int completing;						/* out */
	char buffer[kSMMaxHiRecordDataBufferSize];		/* out */
} SM_FILE_RECORD_PARMS;

Description

Prepares channel for recording of data to a file from an input channel previously allocated by a call to sm_channel_alloc_placed().

The status field is used to indicate the current status of the record. On return from a successful invocation of sm_record_file_start() it will be set to a value of ERR_SM_PENDING and will continue to have this value until recording has been completed, aborted or terminated on occurrence of an error.

The fields private_length and buffer are used internally by the high level library and should not be accessed by the application.

The recording is finished when a call to sm_record_file_complete() returns.

Fields

fd
The file into which the data is to be recorded. This must have been opened with C standard I/O library function fopen() unless the library was built for Microsoft Windows with the C preprecessor symbol __SMWIN32HLIB__ defined, in which case it must be a Windows HANDLE. It is recommended that the Prosody high level BFILE play/record is used where possible instead of rebuilding this library, since it avoids the risk of accidentally using the library built for the wrong type of file access.
record_parms
A structure as defined for sm_record_start.
status
The status of the record.
private_length
A field reserved for the library.
completing
A field reserved for the library.
buffer
A field reserved for the library.

Returns

0 if call completed successfully, otherwise a standard error such as:

This function is part of the Prosody high level FILE play/record API.