FileSink Class Reference

#include <FileSink.hh>

Inheritance diagram for FileSink:

Collaboration diagram for FileSink:

Public Types
typedef void	afterPlayingFunc(void *clientData)

Public Member Functions
virtual void	addData (unsigned char const *data, unsigned dataSize, struct timeval presentationTime)
Boolean	startPlaying (MediaSource &source, afterPlayingFunc *afterFunc, void *afterClientData)
virtual void	stopPlaying ()
virtual Boolean	isRTPSink () const
FramedSource *	source () const
UsageEnvironment &	envir () const
char const *	name () const
virtual Boolean	isSource () const
virtual Boolean	isRTCPInstance () const
virtual Boolean	isRTSPClient () const
virtual Boolean	isRTSPServer () const
virtual Boolean	isMediaSession () const
virtual Boolean	isServerMediaSession () const

Static Public Member Functions
static FileSink *	createNew (UsageEnvironment &env, char const *fileName, unsigned bufferSize=20000, Boolean oneFilePerFrame=False)
static Boolean	lookupByName (UsageEnvironment &env, char const *sinkName, MediaSink *&resultSink)
static Boolean	lookupByName (UsageEnvironment &env, char const *mediumName, Medium *&resultMedium)
static void	close (UsageEnvironment &env, char const *mediumName)
static void	close (Medium *medium)

Protected Member Functions
	FileSink (UsageEnvironment &env, FILE *fid, unsigned bufferSize, char const *perFrameFileNamePrefix)
virtual	~FileSink ()
virtual Boolean	continuePlaying ()
virtual void	afterGettingFrame (unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime)
virtual Boolean	sourceIsCompatibleWithUs (MediaSource &source)
void	onSourceClosure ()
TaskToken &	nextTask ()

Static Protected Member Functions
static void	afterGettingFrame (void *clientData, unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)
static void	onSourceClosure (void *clientData)

Protected Attributes
FILE *	fOutFid
unsigned char *	fBuffer
unsigned	fBufferSize
char *	fPerFrameFileNamePrefix
char *	fPerFrameFileNameBuffer
struct timeval	fPrevPresentationTime
unsigned	fSamePresentationTimeCounter
FramedSource *	fSource

Private Member Functions
virtual Boolean	isSink () const

Private Attributes
afterPlayingFunc *	fAfterFunc
void *	fAfterClientData
UsageEnvironment &	fEnviron
char	fMediumName [mediumNameMaxLen]
TaskToken	fNextTask

Detailed Description

Definition at line 28 of file FileSink.hh.

Member Typedef Documentation

afterPlayingFunc

typedef void MediaSink::afterPlayingFunc(void *clientData)

inherited

Definition at line 33 of file MediaSink.hh.

Constructor & Destructor Documentation

FileSink()

FileSink::FileSink ( UsageEnvironment & env, FILE * fid, unsigned bufferSize, char const * perFrameFileNamePrefix )

protected

Referenced by createNew().

~FileSink()

virtual FileSink::~FileSink ( )

protectedvirtual

Member Function Documentation

addData()

virtual void FileSink::addData ( unsigned char const * data, unsigned dataSize, struct timeval presentationTime )

virtual

Reimplemented in OggFileSink.

afterGettingFrame() [1/2]

virtual void FileSink::afterGettingFrame ( unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime )

protectedvirtual

Reimplemented in AMRAudioFileSink, H264or5VideoFileSink, and OggFileSink.

afterGettingFrame() [2/2]

void FileSink::afterGettingFrame ( void * clientData, unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds )

staticprotected

close() [1/2]

void Medium::close ( Medium * medium )

staticinherited

References Medium().

close() [2/2]

void Medium::close ( UsageEnvironment & env, char const * mediumName )

staticinherited

continuePlaying()

virtual Boolean FileSink::continuePlaying ( )

protectedvirtual

Implements MediaSink.

Reimplemented in OggFileSink.

createNew()

FileSink * FileSink::createNew ( UsageEnvironment & env, char const * fileName, unsigned bufferSize = 20000, Boolean oneFilePerFrame = False )

static

References False, and FileSink().

envir()

UsageEnvironment & Medium::envir ( ) const

inlineinherited

Definition at line 59 of file Media.hh.

{return fEnviron;}

References fEnviron.

Referenced by MediaSubsession::env(), GenericMediaServer::ClientConnection::envir(), GenericMediaServer::ClientSession::envir(), and RTPInterface::envir().

isMediaSession()

virtual Boolean Medium::isMediaSession ( ) const

virtualinherited

Reimplemented in MediaSession.

isRTCPInstance()

virtual Boolean Medium::isRTCPInstance ( ) const

virtualinherited

Reimplemented in RTCPInstance.

isRTPSink()

virtual Boolean MediaSink::isRTPSink ( ) const

virtualinherited

Reimplemented in RTPSink.

isRTSPClient()

virtual Boolean Medium::isRTSPClient ( ) const

virtualinherited

Reimplemented in RTSPClient.

isRTSPServer()

virtual Boolean Medium::isRTSPServer ( ) const

virtualinherited

Reimplemented in RTSPServer.

isServerMediaSession()

virtual Boolean Medium::isServerMediaSession ( ) const

virtualinherited

Reimplemented in ServerMediaSession.

isSink()

virtual Boolean MediaSink::isSink ( ) const

privatevirtualinherited

Reimplemented from Medium.

isSource()

virtual Boolean Medium::isSource ( ) const

virtualinherited

Reimplemented in MediaSource.

lookupByName() [1/2]

Boolean MediaSink::lookupByName ( UsageEnvironment & env, char const * sinkName, MediaSink *& resultSink )

staticinherited

References MediaSink().

lookupByName() [2/2]

Boolean Medium::lookupByName ( UsageEnvironment & env, char const * mediumName, Medium *& resultMedium )

staticinherited

References Medium().

name()

char const * Medium::name ( ) const

inlineinherited

Definition at line 61 of file Media.hh.

{return fMediumName;}

References fMediumName.

Referenced by QuickTimeFileSink::_atom(), RTSPServer::lookupByName(), RTCPInstance::sendAppPacket(), and OnDemandServerMediaSubsession::sendRTCPAppPacket().

nextTask()

TaskToken & Medium::nextTask ( )

inlineprotectedinherited

Definition at line 77 of file Media.hh.

                        {
        return fNextTask;
  }

References fNextTask.

onSourceClosure() [1/2]

void MediaSink::onSourceClosure ( )

protectedinherited

onSourceClosure() [2/2]

void MediaSink::onSourceClosure ( void * clientData )

staticprotectedinherited

source()

FramedSource * MediaSink::source ( ) const

inlineinherited

Definition at line 42 of file MediaSink.hh.

{return fSource;}

References fSource.

Referenced by AMRAudioFileSink::sourceIsCompatibleWithUs(), AMRAudioRTPSink::sourceIsCompatibleWithUs(), DVVideoRTPSink::sourceIsCompatibleWithUs(), H264VideoRTPSink::sourceIsCompatibleWithUs(), H265VideoRTPSink::sourceIsCompatibleWithUs(), HLSSegmenter::sourceIsCompatibleWithUs(), JPEGVideoRTPSink::sourceIsCompatibleWithUs(), sourceIsCompatibleWithUs(), MPEG1or2VideoRTPSink::sourceIsCompatibleWithUs(), MPEG4ESVideoRTPSink::sourceIsCompatibleWithUs(), and startPlaying().

sourceIsCompatibleWithUs()

virtual Boolean MediaSink::sourceIsCompatibleWithUs ( MediaSource & source )

protectedvirtualinherited

Reimplemented in AMRAudioFileSink, AMRAudioRTPSink, DVVideoRTPSink, H264VideoRTPSink, H265VideoRTPSink, HLSSegmenter, JPEGVideoRTPSink, MPEG1or2VideoRTPSink, and MPEG4ESVideoRTPSink.

References source().

startPlaying()

Boolean MediaSink::startPlaying ( MediaSource & source, afterPlayingFunc * afterFunc, void * afterClientData )

inherited

References source().

stopPlaying()

virtual void MediaSink::stopPlaying ( )

virtualinherited

Reimplemented in MultiFramedRTPSink.

Field Documentation

fAfterClientData

void* MediaSink::fAfterClientData

privateinherited

Definition at line 67 of file MediaSink.hh.

fAfterFunc

afterPlayingFunc* MediaSink::fAfterFunc

privateinherited

Definition at line 66 of file MediaSink.hh.

fBuffer

unsigned char* FileSink::fBuffer

protected

Definition at line 63 of file FileSink.hh.

fBufferSize

unsigned FileSink::fBufferSize

protected

Definition at line 64 of file FileSink.hh.

fEnviron

UsageEnvironment& Medium::fEnviron

privateinherited

Definition at line 82 of file Media.hh.

Referenced by envir().

fMediumName

char Medium::fMediumName[mediumNameMaxLen]

privateinherited

Definition at line 83 of file Media.hh.

Referenced by name().

fNextTask

TaskToken Medium::fNextTask

privateinherited

Definition at line 84 of file Media.hh.

Referenced by nextTask().

fOutFid

FILE* FileSink::fOutFid

protected

Definition at line 62 of file FileSink.hh.

fPerFrameFileNameBuffer

char* FileSink::fPerFrameFileNameBuffer

protected

Definition at line 66 of file FileSink.hh.

fPerFrameFileNamePrefix

char* FileSink::fPerFrameFileNamePrefix

protected

Definition at line 65 of file FileSink.hh.

fPrevPresentationTime

struct timeval FileSink::fPrevPresentationTime

protected

Definition at line 67 of file FileSink.hh.

fSamePresentationTimeCounter

unsigned FileSink::fSamePresentationTimeCounter

protected

Definition at line 68 of file FileSink.hh.

fSource

FramedSource* MediaSink::fSource

protectedinherited

Definition at line 58 of file MediaSink.hh.

Referenced by source().

---

The documentation for this class was generated from the following file:

• liveMedia/include/FileSink.hh