This is returned from the CNTV2Card::AutoCirculateGetStatus function.
More...
#include <ntv2publicinterface.h>
This is returned from the CNTV2Card::AutoCirculateGetStatus function.
- Note
- This struct uses a constructor to properly initialize itself. Do not use memset or bzero to initialize or "clear" it.
Definition at line 7160 of file ntv2publicinterface.h.
◆ AUTOCIRCULATE_STATUS()
◆ CanAcceptMoreOutputFrames()
| bool AUTOCIRCULATE_STATUS::CanAcceptMoreOutputFrames |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if the device's AutoCirculate channel is ready to accept at least one more output frame.
Definition at line 7231 of file ntv2publicinterface.h.
◆ Clear()
| void AUTOCIRCULATE_STATUS::Clear |
( |
void |
| ) |
|
◆ CopyFrom()
◆ CopyTo()
◆ GetActiveFrame()
| LWord AUTOCIRCULATE_STATUS::GetActiveFrame |
( |
void |
| ) |
const |
|
inline |
◆ GetAudioSystem()
- Returns
- My audio system. If NTV2_AUDIOSYSTEM_INVALID, then no audio is being captured/played.
Definition at line 7261 of file ntv2publicinterface.h.
◆ GetBufferLevel()
| ULWord AUTOCIRCULATE_STATUS::GetBufferLevel |
( |
void |
| ) |
const |
|
inline |
- Returns
- The number of buffered frames in the driver ready to capture or play.
Definition at line 7221 of file ntv2publicinterface.h.
◆ GetChannel()
| NTV2Channel AUTOCIRCULATE_STATUS::GetChannel |
( |
void |
| ) |
const |
◆ GetDroppedFrameCount()
| ULWord AUTOCIRCULATE_STATUS::GetDroppedFrameCount |
( |
void |
| ) |
const |
|
inline |
- Returns
- The total number of frames dropped since AutoCirculateStart called.
Definition at line 7211 of file ntv2publicinterface.h.
◆ GetEndFrame()
| uint16_t AUTOCIRCULATE_STATUS::GetEndFrame |
( |
void |
| ) |
const |
|
inline |
◆ GetFrameCount()
| ULWord AUTOCIRCULATE_STATUS::GetFrameCount |
( |
void |
| ) |
const |
|
inline |
◆ GetMode()
| NTV2Mode AUTOCIRCULATE_STATUS::GetMode |
( |
void |
| ) |
const |
|
inline |
- Returns
- The NTV2Mode, whether NTV2_MODE_OUTPUT, NTV2_MODE_INPUT or NTV2_MODE_INVALID (if stopped).
Definition at line 7356 of file ntv2publicinterface.h.
◆ GetNumAvailableOutputFrames()
| ULWord AUTOCIRCULATE_STATUS::GetNumAvailableOutputFrames |
( |
void |
| ) |
const |
|
inline |
- Returns
- The number of "unoccupied" output (playout) frames the device's AutoCirculate channel can currently accommodate.
Definition at line 7226 of file ntv2publicinterface.h.
◆ GetProcessedFrameCount()
| ULWord AUTOCIRCULATE_STATUS::GetProcessedFrameCount |
( |
void |
| ) |
const |
|
inline |
- Returns
- The total number of frames successfully processed (not dropped) since AutoCirculateStart called.
Definition at line 7216 of file ntv2publicinterface.h.
◆ GetStartFrame()
| uint16_t AUTOCIRCULATE_STATUS::GetStartFrame |
( |
void |
| ) |
const |
|
inline |
◆ GetState()
◆ HasAvailableInputFrame()
| bool AUTOCIRCULATE_STATUS::HasAvailableInputFrame |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if there's at least one captured frame that's ready to transfer from the device to the host; otherwise false.
Definition at line 7236 of file ntv2publicinterface.h.
◆ IsFieldMode()
| bool AUTOCIRCULATE_STATUS::IsFieldMode |
( |
void |
| ) |
const |
|
inline |
◆ IsInput()
| bool AUTOCIRCULATE_STATUS::IsInput |
( |
void |
| ) |
const |
|
inline |
◆ IsOutput()
| bool AUTOCIRCULATE_STATUS::IsOutput |
( |
void |
| ) |
const |
|
inline |
◆ IsPaused()
| bool AUTOCIRCULATE_STATUS::IsPaused |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if my state is currently NTV2_AUTOCIRCULATE_PAUSED; otherwise false.
Definition at line 7286 of file ntv2publicinterface.h.
◆ IsRunning()
| bool AUTOCIRCULATE_STATUS::IsRunning |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if my state is currently NTV2_AUTOCIRCULATE_RUNNING; otherwise false.
Definition at line 7266 of file ntv2publicinterface.h.
◆ IsStarting()
| bool AUTOCIRCULATE_STATUS::IsStarting |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if my state is currently NTV2_AUTOCIRCULATE_STARTING or NTV2_AUTOCIRCULATE_STARTING_AT_TIME; otherwise false.
Definition at line 7271 of file ntv2publicinterface.h.
◆ IsStopped()
| bool AUTOCIRCULATE_STATUS::IsStopped |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if my state is currently NTV2_AUTOCIRCULATE_DISABLED; otherwise false.
Definition at line 7276 of file ntv2publicinterface.h.
◆ IsStopping()
| bool AUTOCIRCULATE_STATUS::IsStopping |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if my state is currently NTV2_AUTOCIRCULATE_STOPPING; otherwise false.
Definition at line 7281 of file ntv2publicinterface.h.
◆ operator NTV2_HEADER *()
◆ operator[]()
| string AUTOCIRCULATE_STATUS::operator[] |
( |
const unsigned |
inIndexNum | ) |
const |
- Returns
- A string containing the human-readable data for the given zero-based index value.
- Parameters
-
| [in] | inIndexNum | A zero-based index number that specifies which member data value to return. |
Definition at line 2506 of file ntv2publicinterface.cpp.
◆ OptionFlags()
| ULWord AUTOCIRCULATE_STATUS::OptionFlags |
( |
void |
| ) |
const |
|
inline |
◆ RPCDecode()
| bool AUTOCIRCULATE_STATUS::RPCDecode |
( |
const NTV2_RPC_BLOB_TYPE & |
inBlob, |
|
|
size_t & |
inOutIndex |
|
) |
| |
◆ RPCEncode()
◆ WithAudio()
| bool AUTOCIRCULATE_STATUS::WithAudio |
( |
void |
| ) |
const |
|
inline |
◆ WithColorCorrect()
| bool AUTOCIRCULATE_STATUS::WithColorCorrect |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if AUTOCIRCULATE_WITH_COLORCORRECT enabled; otherwise false.
Definition at line 7326 of file ntv2publicinterface.h.
◆ WithCustomAnc()
| bool AUTOCIRCULATE_STATUS::WithCustomAnc |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if operating the custom Anc inserter/extractor; otherwise false.
Definition at line 7301 of file ntv2publicinterface.h.
◆ WithFBFChange()
| bool AUTOCIRCULATE_STATUS::WithFBFChange |
( |
void |
| ) |
const |
|
inline |
◆ WithFBOChange()
| bool AUTOCIRCULATE_STATUS::WithFBOChange |
( |
void |
| ) |
const |
|
inline |
◆ WithHDMIAuxData()
| bool AUTOCIRCULATE_STATUS::WithHDMIAuxData |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if capturing/playing with HDMI auxiliary data; otherwise false.
Definition at line 7341 of file ntv2publicinterface.h.
◆ WithLTC()
| bool AUTOCIRCULATE_STATUS::WithLTC |
( |
void |
| ) |
const |
|
inline |
- Returns
- True if capturing/playing analog LTC timecode; otherwise false.
Definition at line 7311 of file ntv2publicinterface.h.
◆ WithRP188()
| bool AUTOCIRCULATE_STATUS::WithRP188 |
( |
void |
| ) |
const |
|
inline |
◆ WithVidProc()
| bool AUTOCIRCULATE_STATUS::WithVidProc |
( |
void |
| ) |
const |
|
inline |
◆ acActiveFrame
| LWord AUTOCIRCULATE_STATUS::acActiveFrame |
◆ acAudioClockCurrentTime
| ULWord64 AUTOCIRCULATE_STATUS::acAudioClockCurrentTime |
◆ acAudioClockStartTime
| ULWord64 AUTOCIRCULATE_STATUS::acAudioClockStartTime |
◆ acAudioSystem
The audio system being used for this channel (NTV2_AUDIOSYSTEM_INVALID if none)
Definition at line 7175 of file ntv2publicinterface.h.
◆ acBufferLevel
| ULWord AUTOCIRCULATE_STATUS::acBufferLevel |
◆ acCrosspoint
◆ acEndFrame
| LWord AUTOCIRCULATE_STATUS::acEndFrame |
Last frame to circulate. FIXFIXFIX Why is this signed? CHANGE TO ULWord??
Definition at line 7165 of file ntv2publicinterface.h.
◆ acFramesDropped
| ULWord AUTOCIRCULATE_STATUS::acFramesDropped |
◆ acFramesProcessed
| ULWord AUTOCIRCULATE_STATUS::acFramesProcessed |
◆ acHeader
◆ acOptionFlags
| ULWord AUTOCIRCULATE_STATUS::acOptionFlags |
◆ acRDTSCCurrentTime
| ULWord64 AUTOCIRCULATE_STATUS::acRDTSCCurrentTime |
◆ acRDTSCStartTime
| ULWord64 AUTOCIRCULATE_STATUS::acRDTSCStartTime |
◆ acStartFrame
| LWord AUTOCIRCULATE_STATUS::acStartFrame |
First frame to circulate. FIXFIXFIX Why is this signed? CHANGE TO ULWord??
Definition at line 7164 of file ntv2publicinterface.h.
◆ acState
◆ acTrailer
The documentation for this class was generated from the following files: