Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

SH::FileSourceSH Class Reference
[StreamHandlers]

#include <MNFileSourceSH.h>

Inheritance diagram for SH::FileSourceSH:

Inheritance graph
[legend]
Collaboration diagram for SH::FileSourceSH:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 FileSourceSH (SHGraphManager *mgr, u_int32_t runtimeId, MNSelector &sel)
virtual ~FileSourceSH ()
virtual SH_RC initSH ()
virtual SH_RC uninitSH ()
virtual SH_RC startStreaming ()
SH_RC changePos (u_int64 pos)
long getPos ()
SH_RC getPos (long &pos)
SH_RC pull_from_file (DataPtr &item, SourceUnit su, size_t amount)
virtual SinkEndpoint ** getSinkSpecs ()
virtual SourceEndpoint ** getSourceSpecs ()
virtual bool isConnected () const

Public Attributes

SA_FILE_NAME _filename
SA_FILESRC_START_POS _start_pos
SA_FILESRC_STOP_POS _stop_pos

Protected Attributes

SourceEndpoint_out_ep_a [1]
FileSourceEndpoint _outEP

Constructor & Destructor Documentation

SH::FileSourceSH::FileSourceSH SHGraphManager mgr,
u_int32_t  runtimeId,
MNSelector sel
 

virtual SH::FileSourceSH::~FileSourceSH  )  [virtual]
 


Member Function Documentation

SH_RC SH::FileSourceSH::changePos u_int64  pos  )  [virtual]
 

Reimplemented from SH::Base.

SH_RC SH::FileSourceSH::getPos long &  pos  ) 
 

long SH::FileSourceSH::getPos  ) 
 

virtual SinkEndpoint** SH::FileSourceSH::getSinkSpecs  )  [virtual]
 

Provide a list of valid sink endpoint specifications to the graph manager.
getSinkPorts() is called by the graph manager and returns an array of pointers to EndpointSpec structures, or NULL if no endpoints in this direction are supported. It is typical that the length of such an array is 1, because several alternatives are specified by one EndpointSpec object, and the maximum number of identical Endpoints is a parameter of the EndpointSpec as well. The maximum number of endpoints may be dynamic, e.g. in an RTP source SH, new SSRCs or PTs will result in the provision of a new Endpoint. The array of endpoint specs is not NULL terminated, it is expected that the application knows the number of endpoints from numSinkSpecs().

Returns:
An array of endpoint specification.

Implements SH::Status.

virtual SourceEndpoint** SH::FileSourceSH::getSourceSpecs  )  [virtual]
 

Provide a list of valid source endpoint specifications to the graph manager.
getSourceSpecs() works like getSinkSpecs() but on the source endpoint specifications.

Returns:
An array of endpoint specification.

Implements SH::Status.

virtual SH_RC SH::FileSourceSH::initSH  )  [virtual]
 

See also:
SH

Reimplemented from SH::Base.

virtual bool SH::FileSourceSH::isConnected  )  const [virtual]
 

Indicate whether a sufficient number of endpoints are connected for the stream handler to be active.
True if a sufficient number of endpoints is connected for the stream handler to operate in a graph. This should always be true when the stream handler is part of an active graph. This can be called on all stream handlers of a graph to determine whether it will activate successfully.

Implements SH::Status.

SH_RC SH::FileSourceSH::pull_from_file DataPtr item,
SourceUnit  su,
size_t  amount
 

virtual SH_RC SH::FileSourceSH::startStreaming  )  [virtual]
 

See also:
SH

Reimplemented from SH::Base.

virtual SH_RC SH::FileSourceSH::uninitSH  )  [virtual]
 

See also:
SH

Reimplemented from SH::Base.


Member Data Documentation

SA_FILE_NAME SH::FileSourceSH::_filename
 

SourceEndpoint* SH::FileSourceSH::_out_ep_a[1] [protected]
 

FileSourceEndpoint SH::FileSourceSH::_outEP [protected]
 

SA_FILESRC_START_POS SH::FileSourceSH::_start_pos
 

SA_FILESRC_STOP_POS SH::FileSourceSH::_stop_pos
 


The documentation for this class was generated from the following file:
Generated on Sun Mar 6 13:36:29 2005 for Komssys by doxygen 1.3.8