These functions implement sample clock operations that manipulate the adapter's sample clock generation.
More...
Functions |
| ASX32_API ASX_ERROR | ASX_SampleClock_EnumerateSampleRate (ASX_HANDLE hSampleClock, const int nIndex, enum asxSAMPLE_RATE *peSampleRate, int *pnCount) |
| ASX32_API ASX_ERROR | ASX_SampleClock_EnumerateLocalRate (ASX_HANDLE hSampleClock, const int nIndex, enum asxSAMPLE_RATE *peSampleRate, int *pnCount) |
| | Enumerate each sample clock rates for the local sample clock generator.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_SetSampleRate (ASX_HANDLE hSampleClock, const int nSampleRate) |
| ASX32_API ASX_ERROR | ASX_SampleClock_SetLocalRate (ASX_HANDLE hSampleClock, const int nSampleRate) |
| | Set the sample rate for the local sample clock generator.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_SetLocalRateEx (ASX_HANDLE hSampleClock, const int nSampleRate, const int nSampleRatePPB) |
| | Set the fractional sample rate for the local sample clock generator.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_GetSampleRate (ASX_HANDLE hSampleClock, int *pnSampleRate) |
| | Get the adapter's sample rate.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_GetLocalRate (ASX_HANDLE hSampleClock, int *pnSampleRate) |
| | Get the sample rate for the local sample clock generator.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_EnumerateClockSource (ASX_HANDLE hSampleClock, const int nIndex, enum asxSAMPLE_CLOCK_SOURCE *peClockSource, int *pnCount) |
| | Enumerate each sample clock source option.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_SetClockSource (ASX_HANDLE hSampleClock, const enum asxSAMPLE_CLOCK_SOURCE eClockSource) |
| | Set the sample clock source.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_GetClockSource (ASX_HANDLE hSampleClock, enum asxSAMPLE_CLOCK_SOURCE *peClockSource) |
| | Get the sample clock source.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_SetAutoSource (ASX_HANDLE hSampleClock, const int nEnable) |
| | Set the sample clock to automatically source its clock from a valid input.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_GetAutoSource (ASX_HANDLE hSampleClock, int *pnEnable) |
| | Get the setting of the auto source property of the sample clock.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_SetLocalRateLock (ASX_HANDLE hSampleClock, const int nLock) |
| | Lock the local sample clock to its current setting.
|
| ASX32_API ASX_ERROR | ASX_SampleClock_GetLocalRateLock (ASX_HANDLE hSampleClock, int *pnLock) |
| | Get the setting of the local sample clock lock.
|
Detailed Description
These functions implement sample clock operations that manipulate the adapter's sample clock generation.
Function Documentation
Enumerate each sample clock source option.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| nIndex | The index of the sample clock source option to fetch. |
| peClockSource | The returned sample clock source option. |
| pnCount | The total number of available sample clock sources. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
Enumerate each sample clock rates for the local sample clock generator.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| nIndex | The index of the sample clock rate option to fetch. |
| peSampleRate | The returned sample rate option. |
| pnCount | The total number of available sample rates. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
Get the setting of the auto source property of the sample clock.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| *pnEnable | Returns 1 if enabled or 0 if not. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
Get the sample clock source.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| peClockSource | The returned sample clock source. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
| ASX32_API ASX_ERROR ASX_SampleClock_GetLocalRate |
( |
ASX_HANDLE |
hSampleClock, |
|
|
int * |
pnSampleRate |
|
) |
| |
Get the sample rate for the local sample clock generator.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| pnSampleRate | The returned sample rate. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
Get the setting of the local sample clock lock.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| *pnLock | Returns 1 if enabled or 0 if not. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
| ASX32_API ASX_ERROR ASX_SampleClock_GetSampleRate |
( |
ASX_HANDLE |
hSampleClock, |
|
|
int * |
pnSampleRate |
|
) |
| |
Get the adapter's sample rate.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| pnSampleRate | The returned sample rate. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
| ASX32_API ASX_ERROR ASX_SampleClock_SetAutoSource |
( |
ASX_HANDLE |
hSampleClock, |
|
|
const int |
nEnable |
|
) |
| |
Set the sample clock to automatically source its clock from a valid input.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| nEnable | When set to 1 the auto source is enabled, when 0 it is disabled. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
Set the sample clock source.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| eClockSource | The sample clock source option to set. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
| ASX32_API ASX_ERROR ASX_SampleClock_SetLocalRate |
( |
ASX_HANDLE |
hSampleClock, |
|
|
const int |
nSampleRate |
|
) |
| |
Set the sample rate for the local sample clock generator.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| nSampleRate | The sample rate in Hz to set. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
| ASX32_API ASX_ERROR ASX_SampleClock_SetLocalRateEx |
( |
ASX_HANDLE |
hSampleClock, |
|
|
const int |
nSampleRate, |
|
|
const int |
nSampleRatePPB |
|
) |
| |
Set the fractional sample rate for the local sample clock generator.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| nSampleRate | The sample rate in Hz to set. |
| nSampleRatePPB | The sample rate parts per billion to set. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
| ASX32_API ASX_ERROR ASX_SampleClock_SetLocalRateLock |
( |
ASX_HANDLE |
hSampleClock, |
|
|
const int |
nLock |
|
) |
| |
Lock the local sample clock to its current setting.
For CobraNet adapters that run from a network clock, this function will lock the sample rate of the adapter's players and recorders to the network clock. On an ASI6416 this will result 48 kHz being the only sample rate supported.
- Parameters:
-
| hSampleClock | A handle to an ASX sample clock control. |
| nLock | When set to 1 the local rate is locked, when 0 it is unlocked. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.
| ASX32_API ASX_ERROR ASX_SampleClock_SetSampleRate |
( |
ASX_HANDLE |
hSampleClock, |
|
|
const int |
nSampleRate |
|
) |
| |