diff --git a/ChangeLog b/ChangeLog index 8765340b..194ea20e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -24548,3 +24548,6 @@ ['MO'] CAE command to use play session serial numbers rather than card and stream numbers. * Fixed a regression in rdcartslots(1) that broke audio meters. +2023-12-15 Fred Gleason + * Rewrote the CAE API documentation so as to use the term 'stream' + more consistently. diff --git a/docs/apis/cae.xml b/docs/apis/cae.xml index 101d52fc..3a03d7c0 100644 --- a/docs/apis/cae.xml +++ b/docs/apis/cae.xml @@ -114,8 +114,8 @@ <command>Load Playback</command> Prepare an audio interface to play an audio file, while also muting - all stream-to-port mixer controls for the stream returned in - stream-num. + all stream-to-port mixer controls for the stream that is internally + allocated by caed8. LP serial @@ -171,8 +171,7 @@ <command>Unload Playback</command> - Free an audio playback interface. This will also mute all associated - output stream->output port volume controls. + Free an audio playback interface. UP serial! @@ -184,8 +183,8 @@ - The serial number of the playback event, from the - Load Playback call. + The serial value used in the + corresponding Load Playback command. @@ -208,8 +207,8 @@ - The serial number of the playback event, from the - Load Playback call. + The serial value used in the + corresponding Load Playback command. @@ -244,8 +243,8 @@ - The serial number of the playback event, from the - Load Playback call. + The serial value used in the + corresponding Load Playback command. @@ -299,8 +298,87 @@ - The serial number of the playback event, from the - Load Playback call. + The serial value used in the + corresponding Load Playback command. + + + + + + + + <command>Set Output Volume</command> + + Set the volume of an output playback. + + + OV serial + level! + + + + + serial + + + + The serial value used in the + corresponding Load Playback command. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + + + <command>Fade Output Volume</command> + + Transition the volume of an output playback over time. + + + FV serial + level + length! + + + + + serial + + + + The serial value used in the + corresponding Load Playback command. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + length + + + + The length of the transition, in milliseconds. @@ -359,7 +437,7 @@ - The number of the audio adapter to query. + The number of the audio adapter to use. @@ -369,8 +447,8 @@ - The port number to use. This is relative to the audio adapter - selected. + The input port number to use. This is relative to the audio + adapter selected. @@ -427,6 +505,12 @@ + + Rivendell always assumes that the input port number specified in + port-num corresponds to + the recording stream number used internally by + caed8. + @@ -436,7 +520,7 @@ UR card-num - stream-num! + port-num! @@ -445,18 +529,19 @@ - The number of the audio adapter to use. + The card-num value used in the + corresponding Load Recording command. - stream-num + port-num - The stream number to use. This is relative to the audio adapter - selected. + The port-num value used in the + corresponding Load Recording command. @@ -464,13 +549,13 @@ Returns: UR card-num - stream-num - len! + port-num + length! - len + length @@ -488,7 +573,7 @@ RD card-num - stream-num + port-num length threshold! @@ -499,18 +584,19 @@ - The number of the audio adapter to use. + The card-num value used in the + corresponding Load Recording command. - stream-num + port-num - The stream number to use. This is relative to the audio adapter - selected. + The port-num value used in the + corresponding Load Recording command. @@ -521,7 +607,7 @@ Length of time to record in milliseconds. If zero, record until - told to stop. + sent a Stop Recording command. @@ -551,7 +637,7 @@ SR card-num - stream-num! + port-num! @@ -560,17 +646,19 @@ - The number of the audio adapter. + The card-num value used in the + corresponding Load Recording command. - stream-num + port-num - The stream number. + The port-num value used in the + corresponding Load Recording command. @@ -586,7 +674,7 @@ RS card-num - stream-num! + port-num! @@ -595,27 +683,25 @@ - The number of the audio adapter to use. + The card-num value used in the + corresponding Load Recording command. - stream-num + port-num - The stream number to use. This is relative to the audio adapter - selected. + The port-num value used in the + corresponding Load Recording command. - - - Mixer Operations <command>Set Input Volume</command> @@ -623,147 +709,6 @@ IV card-num - stream-num - level! - - - - - card-num - - - - The number of the audio adapter to use. - - - - - - stream-num - - - - The stream number to use. This is relative to the audio adapter - selected. - - - - - - level - - - - The level, in hundreths of a dB. - - - - - - - - <command>Set Output Volume</command> - - Set the volume of an output playback. - - - OV serial - level! - - - - - serial - - - - The serial number of the playback event, from the - Load Playback call. - - - - - - - level - - - - The level, in hundreths of a dB. - - - - - - - - <command>Fade Output Volume</command> - - Transition the volume of an output playback over time. - - - FV serial - level - length! - - - - - serial - - - - The serial number of the playback event, from the - Load Playback call. - - - - - - level - - - - The level, in hundreths of a dB. - - - - - - length - - - - The length of the transition, in milliseconds. - - - - - - - - <command>Set Input Level</command> - - Set the gain level of an input port. - - - IL card-num port-num level! @@ -774,18 +719,19 @@ - The number of the audio adapter to use. + The card-num value used in the + corresponding Load Recording command. - stream-num + port-num - The port number to use. This is relative to the audio adapter - selected. + The port-num value used in the + corresponding Load Recording command. @@ -802,6 +748,59 @@ + + <command>Set Input Vox Level</command> + + Set the VOX threshold level of an input stream. + + + IX card-num + port-num + level! + + + + + card-num + + + + The card-num value used in the + corresponding Load Recording command. + + + + + + port-num + + + + The port-num value used in the + corresponding Load Recording command. + + + + + + level + + + + The level, in hundreths of a dB. + + + + + + + + + Global Mixer Operations + + These commands operate independently of any specific playback or + recording operation. + <command>Set Output Level</command> @@ -848,13 +847,13 @@ - <command>Set Input Mode</command> + <command>Set Output Mode</command> - Set the mode of an input stream. + Set the mode of an output port. - IM card-num - stream-num + OM card-num + port-num mode! @@ -874,8 +873,8 @@ - The stream number to use. This is relative to the audio adapter - selected. + The output port number to use. This is relative to the audio + adapter selected. @@ -935,100 +934,13 @@ - <command>Set Output Mode</command> + <command>Set Input Level</command> - Set the mode of an output stream. + Set the gain level of an input port. - OM card-num - stream-num - mode! - - - - - card-num - - - - The number of the audio adapter to use. - - - - - - stream-num - - - - The stream number to use. This is relative to the audio adapter - selected. - - - - - - mode - - - - The mode, as follows: - - - - 0 - - - - Normal - - - - - - 1 - - - - Swap left and right channels - - - - - - 2 - - - - Left audio on both channels - - - - - - 3 - - - - Right audio on both channels - - - - - - - - - - - - <command>Set Input Vox Level</command> - - Set the VOX threshold level of an input stream. - - - IX card-num - stream-num + IL card-num + port-num level! @@ -1048,8 +960,8 @@ - The stream number to use. This is relative to the audio adapter - selected. + The input port number to use. This is relative to the audio + adapter selected. @@ -1066,6 +978,93 @@ + + <command>Set Input Mode</command> + + Set the mode of an input port. + + + IM card-num + port-num + mode! + + + + + card-num + + + + The number of the audio adapter to use. + + + + + + port-num + + + + The input port number to use. This is relative to the audio + adapter selected. + + + + + + mode + + + + The mode, as follows: + + + + 0 + + + + Normal + + + + + + 1 + + + + Swap left and right channels + + + + + + 2 + + + + Left audio on both channels + + + + + + 3 + + + + Right audio on both channels + + + + + + + + + + <command>Set Input Type</command> @@ -1435,7 +1434,7 @@ <command>Port Meter Levels</command> - Send current meter level of output stream + Current meter levels of an input or output port. ML @@ -1524,7 +1523,7 @@ <command>Output Stream Meter Levels</command> - Send current meter level of output stream + Send current meter level of the output stream. MO @@ -1605,43 +1604,22 @@ <command>Output Stream Status</command> - The current output stream transport status. + Output stream transport status. MS - card-num - port-num - stream-num + serial status! - card-num + serial - The number of the audio adapter to use. - - - - - - port-num - - - - The port number on the audio adapter. - - - - - - stream-num - - - - The stream number on the audio adapter. + The serial value used in the + corresponding Load Playback command.