set session [new ArchiveSession/Record <media>]
Note: This is an abstract base class. Do not create objects directly of this class
1. set m [$session media]
or 2. $session media $m
Set or query the media associated with this session. Please note that the media is automatically set by the init method of this class. Programmers should not invoke this method directly to set the media.
Returns: In syntax (1), it returns a string that represents the media associated with this session. In syntax (2), the return value is undefined.header_file:
1. set file [$session header_file]
or 2. $session header_file $file
Query or set the header file object associated with this session. file must be an object of class HeaderFile.
Returns: In syntax (1), it returns an object of class HeaderFile if the header file has previously been set, otherwise it returns an empty string. In syntax (2), the return value is undefined. save_in:
1. set directory [$session save_in]
or 2. $session save_in $directory
Query or set the directory name in which the stream data and index files for this session are stored.
Returns: In syntax (1), it returns the name of the directory in which stream data and index files are stored, if the directory has previously been set, otherwise it returns an empty string. In syntax (2), the return value is undefined. session_id:
1. set session_id [$session session_id]
or 2. $session session_id $session_id
Query or set the session-id associated with this session. session_id is simply a string that contains valid filename characters (directory separator characters are not permitted). The session-id is used as a prefix for data and index filenames.
Returns: In syntax (1), it returns the session-id string if it has previously been set, otherwise it returns an empty string. In syntax (2), the return value is undefined. generate_filename:
set path [$session generate_filename]Return a filename that is guaranteed to be unique across all streams and all sessions that are part of this recorder process. The filename does not contain the ".dat" or ".idx" extension. The filename has the following format:
<dir>/<session_id>-<media><media_count>-<count>
where dir is the value returned by the save_in method, session_id is the value returned by the session_id method (if the session_id field is empty, that part of the filename, including the following hyphen, is eliminated), media is the value returned by the media method, media_count is a media-specific counter, so that two sessions with the same media will not collide on their filenames, and count is a session-specific counter, so different streams within a session have different filenames.
Returns: A filename that can be used by the ArchiveStream/Record objects to create data and index files for new streams.
new_stream:
$session notify_observers new_stream <stream>Invoked when the recording session detects a new source and creates a new stream object for it.
stream must be an object of a class that is subclassed from ArchiveStream.
stream_done:
$session notify_observers stream_done <stream>Invoked when the recording session detects an existing source has vanished.
stream must be an object of a class that is subclassed from ArchiveStream.