#include <AudRecordWrap.h>
List of all members.
Detailed Description
The main wrapper around the IAudRecord interface
Constructor & Destructor Documentation
AudRecordCLI::Recorder::Recorder |
( |
IAudRecord * |
pRecord | ) |
[package] |
Construct a Recorder which controls a specified underlying IAudRecord interface
- Parameters:
-
pRecord | The interface to wrap |
Member Function Documentation
IntPtr AudRecordCLI::Recorder::AddCustomTarget |
( |
ITargetSink^ |
pTarget | ) |
|
Adds a target that can manipulate the output audio how it wants, can be called at any time
- Exceptions:
-
ArgumentNullException | if pTarget is null, or an AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Parameters:
-
pTarget | The object that receives the audio data and related notifications |
- Returns:
- An opaque value used to remove the target
IntPtr AudRecordCLI::Recorder::AddFileTarget |
( |
String^ |
fileName | ) |
|
Adds a file to the recording process, can be called at any time
- Parameters:
-
fileName | The file to create |
- Exceptions:
-
ArgumentNullException | if fileName is null, or an AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Returns:
- An opaque value that can be used to remove the stream at a later time
IntPtr AudRecordCLI::Recorder::AddNetworkBroadcastTarget |
( |
DWORD% |
port, |
|
|
DWORD |
maxConnections, |
|
|
bool |
wantUrl, |
|
|
String^ % |
url |
|
) |
| |
Opens a network port and streams the recording through it, can be called at any time
- Exceptions:
-
An | AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Parameters:
-
| port | The port to use, or 0 for a randomly selected one |
| maxConnections | The number of people who can connect to the stream. 5 is the default |
| wantUrl | Whether to return the url to connect to in the url parameter |
[out] | url | The connection url, only returned if wantUrl is true |
- Returns:
- An opaque value used to remove the target
void AudRecordCLI::Recorder::ChangeCodec |
( |
CodecConfig^ |
theConfig | ) |
|
Changes the stream codec or configuration
Turns a managed CodecConfig into a native CodecConfiguration struct and calls the native ChangeCodec function
- Exceptions:
-
ArgumentNullException | if theEndpoint is null, or an AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Parameters:
-
theConfig | The new codec and configuration |
Creates a new recorder initialised with a specific configuration
- Exceptions:
-
ArgumentNullException | if initialConfig is null, or an AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Parameters:
-
initialConfig | Codec and bitrate to start the recorder off with |
- Returns:
- The new wrapper object
Returns current statistics from the recording process
- Exceptions:
-
An | AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Returns:
- The structure containing the statistics
Queries the current state of the stream
- Exceptions:
-
An | AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Returns:
- The state of the stream after the toggle operation
void AudRecordCLI::Recorder::Record |
( |
Endpoint^ |
theEndpoint | ) |
|
Starts the recording process.
Reconstructs a native Endpoint struct from theEndpoint and passes that to the native Record function
- Exceptions:
-
ArgumentNullException | if theEndpoint is null, or an AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Parameters:
-
theEndpoint | The mixer to record from |
void AudRecordCLI::Recorder::RemoveTarget |
( |
IntPtr |
pCookie | ) |
|
Removes a target from the recording process, can be called at any time
- Exceptions:
-
An | AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Parameters:
-
void AudRecordCLI::Recorder::Stop |
( |
| ) |
|
Completely stops the recording process. Record() must be called to restart it
- Exceptions:
-
An | AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
Pauses/Resumes the recording stream
- Exceptions:
-
An | AudRecordException, OutOfMemoryException or ArgumentException based on the return on the native function |
- Returns:
- The state of the stream after the toggle operation
Member Data Documentation
The native interface that is wrapped
A managed wrapper resulting from Marshal::GetObjectFromIUnknown()
The documentation for this class was generated from the following files: