Home > APIs > AppServer API > Examples > Connection and System Status > Channel Status properties
Channel Status properties
| Application [supplied] Status | ||||
| Property | Unmanaged Type | Managed Type | Description | Notes |
|---|---|---|---|---|
| text0 | BSTR | System.String | Custom text string generally provided by the application that owns the channel | |
| text1 | BSTR | System.String | Custom text string generally provided by the application that owns the channel | |
| text2 | BSTR | System.String | Custom text string generally provided by the application that owns the channel | |
| text3 | BSTR | System.String | Custom text string generally provided by the application that owns the channel | |
| statusTemplate | BSTR | System.String | Status templates string last set with a call to IChanStatus::put_StatusTemplate | |
| thumbnailStatus | BSTR | System.String | Indicates the status of the thumbnail provided by the application that owns the channel. Values include: Empty, New, Same, and Unknown. The status is initialized to “Unknown”. It is “New” just after a call toIChanStatus::SetThumbnail. It is “Same” after the first time the thumbnail status is returned by this process. It is “Empty” after a call to IChanStatus::ClearThumbnail. | |
| thumbnail | BYTE SAFEARRAY | System.Object[] | Jpeg thumbnail. | |
| totalstorage | long | System.Int32 | total disk space in MBytes | |
| remainingstorage | long | System.Int32 | remaining disk space in MBytes | |
| pcntstorageremaining | long | System.Int32 | percentage of disk space remaining | |
| timeremainingstr | BSTR | System.String | time remaining on disk displayed as timecode value (depends on how channel is configured) | |
| timeremaining | long | System.Int32 | time remaining in fields (depends on how channel is configured) | |
| Channel Status | ||||
| Property | Unmanaged Type | Managed Type | Description | Notes |
|---|---|---|---|---|
| channelName | BSTR | System.String | Name of this channel (K2: C1, C2, C3, C4; MSeries: R1, P1, R2, P2) | |
| channelType | BSTR | System.String | Values include Player, Recorder, and PlayerRecorder. | |
| ownerName | BSTR | System.String | Name of the application that has allocated this channel | |
| videoFormat | long | System.Int32 | Channel’s configured video format. Enumerated values include: Format525_60Hz_2To1 = 0, Format625_50Hz_2To1, Format720_59_94Hz_1To1, Format720_60Hz_1To1, Format1080_23_98Hz_1To1, Format1080_24Hz_1To1, Format1080_25Hz_1To1, Format1080_29_97Hz_1To1, Format1080_30Hz_1To1, Format1080_25Hz_2To1, Format1080_29_97Hz_2To1, Format1080_30Hz_2To1, Format1035_30Hz_2To1, Format1035_29_97Hz_2To1, VideoFormat_NA, Unknown. |
|
| videoFormatStr | BSTR | System.String | String representation of channel’s configured video format. Values include: Format525_60Hz_2To1, Format625_50Hz_2To1, Format720_59_94Hz_1To1, Format720_60Hz_1To1, Format1080_23_98Hz_1To1, Format1080_24Hz_1To1, Format1080_25Hz_1To1, Format1080_29_97Hz_1To1, Format1080_30Hz_1To1, Format1080_25Hz_2To1, Format1080_29_97Hz_2To1, Format1080_30Hz_2To1, Format1035_30Hz_2To1, Format1035_29_97Hz_2To1, VideoFormat_NA, Unknown. |
|
| fieldsPerFrame | long | System.Int32 | For interlaced video formats this value is 2. For progressive scan, the value is 1. | |
| ganged | BOOL | System.Boolean | whether or not the channel is ganged | |
| gangindex | long | System.Int32 | -1 = unganged, 0 = gang 1, 1 = gang 2 | |
| singlecontroller | BOOL | System.Boolean | whether or not a single channel controls the gang | |
| consolidateaudio | BOOL | System.Boolean | whether or not to record audio from more than one channel | |
| consolidatevideo | BOOL | System.Boolean | whether or not to record video from more than one channel | |
| Asset Status | ||||
| Property | Unmanaged Type | Managed Type | Description | Notes |
|---|---|---|---|---|
| assetname | BSTR | System.String | Asset name. | |
| assetUri | BSTR | System.String | Asset identifier in URI format. The URI string takes the following form: edl/cmf//<machine>/<volume>/<bin>/<name> |
|
| editName | BSTR | System.String | When the channel is playing a List asset, this is the name of the edit currently being played. | |
| nextEditName | BSTR | System.String | When the channel is playing a List asset, this is the name of the next edit to be being played. This status value is currently always blank. | |
| sectionName | BSTR | System.String | When the channel is playing a List asset, this is the name of the section currently being played. | |
| nextSectionName | BSTR | System.String | When the channel is playing a List asset, this is the name of the next section to be being played. This status value is currently always blank. | |
| Timeline Status | ||||
| Property | Unmanaged Type | Managed Type | Description | Notes |
|---|---|---|---|---|
| durationStr | BSTR | System.String | Timecode representation of the channel timeline’s maxPos – minPos value. This is the amount of playable material on the timeline. | r |
| countdownStr | BSTR | System.String | Timecode representation of the maxPos – position value. This is the amount of play time left on the timeline. | r |
| percentComplete | float | float | Channel timeline’s maxPos – position expressed as a percent. If the timeline is being used for a crash record, then the percent complete gets to 100.0 every 10 seconds and starts over at 0.0. | r |
| position | long | System.Int32 | Timeline position in fields. This value will always be 0 or greater. | r |
| portState | long | System.Int32 | Enumerated value indicating the state of the timeline: idle = 0 cued for playback = 1 cued for record = 2 playing = 3 recording = 4. |
r |
| shuttleSpeed | float | float | Current rate. Normal play speed is 1.0. | r |
| sectionCountdownStr | BSTR | System.String | Timecode representation of the end-of-the-current-section – position value. This is the amount of play time left in the current section. | r |
| eventCountdownStr | BSTR | System.String | Timecode representation of the end-of-the-current-edit – position value. This is the amount of play time left in the current section. | r |
| sectionPercent | float | float | Channel timeline’s end-of-the-current-section – position value expressed as a percent. | r |
| Video Status | ||||
| Property | Unmanaged Type | Managed Type | Description | Notes |
|---|---|---|---|---|
| fieldsize | long | System.Int32 | Compressed size of the last played field in bytes. | r |
| pixCoding | BSTR | System.String | I, B, or P | r |
| Audio Status (track 0) | ||||
| Property | Unmanaged Type | Managed Type | Description | Notes |
|---|---|---|---|---|
| inputGain0 | float | float | Audio input gain value. This is used to adjust the input audio level. Units are in dBU. Range is –40.0 to 20.0. | r |
| outputGain0 | float | float | Audio output gain value. This is used to adjust the output audio level. Units are in dBU. Range is –40.0 to 20.0. | r |
| audioLevel0 | float | float | Current audio level after gain value has been applied. Units are in dBU. | r |
| Audio Status (track 1) | ||||
| Property | Unmanaged Type | Managed Type | Description | Notes |
|---|---|---|---|---|
| inputGain1 | float | float | Audio input gain value. This is used to adjust the input audio level. Units are in dBU. Range is –40.0 to 20.0. | r |
| outputGain1 | float | float | Audio output gain value. This is used to adjust the output audio level. Units are in dBU. Range is –40.0 to 20.0. | r |
| audioLevel1 | float | float | Current audio level after gain value has been applied. Units are in dBU. | r |
| Timecode Status | ||||
| Property | Unmanaged Type | Managed Type | Description | Notes |
|---|---|---|---|---|
| timecodeStr | BSTR | System.String | When EE or recording, TimecodeStr is the status value from the first timecode resource’s current timecode source (VITC, LTC, or INT). When playing back, TimecodeStr represents the timecode media value. | r |
Notes:
r – Status is available in a range of values (IChanStatus::GetStatusRange)
