Maestro Audio Framework v 1.5
NXP Semiconductors
file_sink.h File Reference

This file includes defines, enums and typedefs for file sink. More...

#include "streamer_element.h"

Data Structures

struct  ElementFileSink
 
struct  FileDump
 

Macros

#define DEFAULT_FILESINK_LOCATION   "rec.pcm"
 Default file sink location (file name)
 

Functions

void FILE_Dump_Task (void *param)
 this function is a task that writes data to the SD card More...
 
int32_t filesink_init_element (StreamElement *element)
 this function initializes the audio sink element and sink pads More...
 
int32_t filesink_set_location (ElementHandle element, char *path)
 This function sets a destiniaiton file to be writen by file sink. More...
 
int32_t filesink_set_write_mode (ElementHandle element, uint8_t write_mode)
 Set the raw write mode or the packet header mode to write to file. More...
 

Function Documentation

◆ FILE_Dump_Task()

void FILE_Dump_Task ( void *  param)
Parameters
paramNULL

◆ filesink_init_element()

int32_t filesink_init_element ( StreamElement *  element)
Parameters
elementan element which is created by parent element
Returns
StreamReturnType
Return values
STREAM_OKif successful
STREAM_ERR_INVALID_ARGSmeans invalid arguments

◆ filesink_set_location()

int32_t filesink_set_location ( ElementHandle  element,
char *  path 
)
Parameters
elementelement handle
pathpointer to a file path
Returns
StreamReturnType
Return values
STREAM_OKif successful
STREAM_ERR_INVALID_ARGSmeans invalid arguments

◆ filesink_set_write_mode()

int32_t filesink_set_write_mode ( ElementHandle  element,
uint8_t  write_mode 
)
Parameters
elementelement handle
write_modewrite mode raw (or) packet header
Returns
: StreamReturnType
Return values
STREAM_OKif successful
STREAM_ERR_INVALID_ARGSmeans invalid arguments