Harlequin RIP SDK

Functions for interfacing the skinkit streaming device with the client stream implementations. More...

#include "std.h"
#include "ripcall.h"
#include "streams.h"

Functions

HqBool registerStreamReader (const char *devname, const char *pFile, HqnReadStream *pRS)
 Register an input stream against a file name. More...
 
HqBool registerStreamWriter (const char *devname, const char *pFile, HqnWriteStream *pWS)
 Register an output stream against a file name. More...
 
void UnregisterStreamReaderWriter (const char *devname, const char *pFile)
 Unregister the input/output stream associated with the file. More...
 

Detailed Description

Functions for interfacing the skinkit streaming device with the client stream implementations.

Deprecated:

The streaming device is implemented in streamdev.c in the skinkit. It is a relative file device, but it supports just two special file descriptors: "/input" and "/output". The input file will read its data from a HqnReadStream structure; the output file will write its data to a HqnWriteStream structure. The interfaces in this file provide a way for the outside world to connect the HqnReadStream and HqnWriteStream implementations to the streaming device. They also permit the implementation to be cleared again. When no implementation is connected, the streaming device will generate ioerrors upon attempting to access the abstract files.

Function Documentation

◆ registerStreamReader()

HqBool registerStreamReader ( const char *  devname,
const char *  pFile,
HqnReadStream pRS 
)

Register an input stream against a file name.

Parameters
devnamedevice name;
pFilefile name;
pRSinput stream;
Returns
TRUE if successful, FALSE otherwise.

◆ registerStreamWriter()

HqBool registerStreamWriter ( const char *  devname,
const char *  pFile,
HqnWriteStream pWS 
)

Register an output stream against a file name.

Parameters
devnamedevice name;
pFilefile name;
pWSwrite stream;
Returns
TRUE if successful, FALSE otherwise.

◆ UnregisterStreamReaderWriter()

void UnregisterStreamReaderWriter ( const char *  devname,
const char *  pFile 
)

Unregister the input/output stream associated with the file.

Parameters
devnamedevice name;
pFilefile name;