MultiCam Boards Documentation > MultiCam Documentation > MultiCam Reference > Channel Class > Channel Management Category > Select Level (Channel Management) > ChannelState

ChannelState

Description

Type

Enumerated

Description

State of the channel

"Set" effect

Activates or de-activates the channel

"Get" effect

Returns the current channel state

Classification

Class

Channel

Category

Channel Management

Level

Select

Identifiers

String

ChannelState

C, C++

MC_ChannelState

.NET

MC.ChannelState

Numerical

15

This parameter gives access to the state of the channel.

Refer to Automatic Switching.

Values applicable to Grablink and Domino boards

State returned on "Get"

Name

Identifier

Description

ORPHAN

MC_ChannelState_ORPHAN

The channel has no grabber.

IDLE

MC_ChannelState_IDLE

The channel owns the grabber at this moment but does not lock it.

READY

MC_ChannelState_READY

The channel locks the grabber and is ready to start an acquisition sequence.

ACTIVE

MC_ChannelState_ACTIVE

The channel uses the grabber.

"Set" effect

Name

Identifier

Description

IDLE

MC_ChannelState_IDLE

Sets the channel's state to IDLE or READY.

FREE

MC_ChannelState_FREE

Try to set the channel's state to ORPHAN.

READY

MC_ChannelState_READY

Try to set the channel's state to READY.

ACTIVE

MC_ChannelState_ACTIVE

Sets the channel's state to ACTIVE.

Values applicable to Picolo boards

State returned on "Get"

Name

Identifier

Description

IDLE

MC_ChannelState_IDLE

The channel owns the grabber at this moment but does not lock it.

ACTIVE

MC_ChannelState_ACTIVE

The channel uses the grabber.

"Set" effect

Name

Identifier

Description

IDLE

MC_ChannelState_IDLE

Sets the channel's state to IDLE or READY.

ACTIVE

MC_ChannelState_ACTIVE

Sets the channel's state to ACTIVE.