|
SAA_channelInit
Initializes and starts a channel run for the current scene.
A channel run begins with a call to SAA_channelInit and ends with a call
to SAA_channelCleanup.
SAA_channelInit starts a channel run using the channel setup of the
current scene. To run with a different channel setup, use SAA_channelLoadSetup to load a channel setup
file (.chn) before you call SAA_channelInit.
SAA_channelInit can also initialize a take recording session.
If another channel run is already underway, SAA_channelInit stops it by
calling SAA_channelCleanup.
set selectAll 0 # or 1
set takeMode 0 # or 1
set path "take_directory"
set name "take_filename"
set requestedId 1
set saveType [SAA_AllocChannelTakeTypes]
SAA_channelInit $selectAll $takeMode $path $name $requestedId $saveType
selectAll- If
1, all scene elements are selected before the channel run is started.
takeMode- If
1, take recording is initialized using the path, name,
requestId, and saveType arguments.
path- Directory where the take recording data is saved.
name- Name of the take. If
name is NULL, the name default.CHD
is used.
requestedId- Numeric ID for the take. If this ID is already assigned to a previous take, the next
highest number is used.
- The
requestedId argument sets the default ID for a take session. If you
perform multiple takes, you can override this default when you call SAA_channelStartTake, or you can let SAAPHIRE
automatically increment the take ID.
saveType- Specifies whether the take data is saved in ASCII or binary format:
SAA_CHANNEL_TAKE_ASCII SAA_CHANNEL_TAKE_BINARY
- The
saveType argument sets the default save type for a take session. You
can override this default when you call SAA_channelStartTake.
Return Value
Return correct usage if incorrect parameters are passed
"SI_ERR_ERROR_MSG" if an old channel run could not be cleaned up,
there is no current channel setup, the channel run could not be initialized, or the take
directory is invalid.
|
SAA_channelInit