ITeiChannelMapManagerService Interface Reference


Description

Technical Preview:
This interface is a TECHNICAL PREVIEW, it may change. The ITeiChannelMapManagerService interface provides APIs for applications to obtain channel map related information for AQAM systems. For AQAM systems, this service should be used instead of the IToiChannelMapService, which supports DVB systems. Using the IToiChannelMapService in an AQAM system will return zero records.

import "ITeiChannelMapManagerService.idl";

List of all members.

Public Member Functions

void GetVctData (in TTeiVcn startVcn, in long requestedNumChannels, out TTeiVctDataSequence vctList) raises (TToiInvalidArgumentException)
void GetDcbm (out TTeiDcbmSequence dcbm) raises (TToiInvalidArgumentException)
void GetVirtualChannels (in TTeiSourceId sourceId, out TTeiVcnSequence vcns) raises (TToiInvalidArgumentException)
void GetVirtualChannel (in long appId, out TTeiVcn vcn) raises (TToiInvalidArgumentException)
void GetSourceId (in TTeiVcn vcn, out TTeiSourceId sourceId) raises (TToiInvalidArgumentException)
void GetApplicationId (in TTeiVcn vcn, out long appId) raises (TToiInvalidArgumentException)
void GetSourceName (in TTeiSourceId sourceId, out string sourceName) raises (TToiInvalidArgumentException)
void GetSourceIdFromSourceName (in string sourceName, out TTeiSourceId sourceId) raises (TToiInvalidArgumentException)
void GetTuneType (in TTeiVcn vcn, out TTeiTuneType tuneType) raises (TToiInvalidArgumentException)
void GetTuningParameters (in TTeiVcn vcn, out TTeiTuningParameters tuningParameters) raises (TToiInvalidArgumentException)

Classes

struct  TTeiTuningParameters
struct  TTeiVctData

Public Types

enum  TTeiServiceType { SERVICE_TYPE_UNKNOWN, SERVICE_TYPE_ANALOG, SERVICE_TYPE_MPEG2_DIGITAL }
enum  TTeiChannelAttribute { CHANNEL_ATTRIBUTE_NORMAL, CHANNEL_ATTRIBUTE_HIDDEN }
enum  TTeiModulationFormat {
  UNKNOWN_MODULATION, QPSK_MODULATION, BPSK_MODULATION, QQPSK_MODULATION,
  VSB_8_MODULATION, VSB_16_MODULATION, QAM_16_MODULATION, QAM_32_MODULATION,
  QAM_64_MODULATION, QAM_80_MODULATION, QAM_96_MODULATION, QAM_112_MODULATION,
  QAM_128_MODULATION, QAM_160_MODULATION, QAM_192_MODULATION, QAM_224_MODULATION,
  QAM_256_MODULATION, QAM_320_MODULATION, QAM_384_MODULATION, QAM_448_MODULATION,
  QAM_512_MODULATION, QAM_640_MODULATION, QAM_768_MODULATION, QAM_896_MODULATION,
  QAM_1024_MODULATION
}
enum  TTeiTuneType { TUNE_TYPE_QAM, TUNE_TYPE_IP }
typedef long TTeiVcn
typedef long TTeiSourceId
typedef long TTeiServiceNumber
typedef long TTeiFrequency
typedef sequence< long > TTeiDcbmSequence
typedef sequence< TTeiVctDataTTeiVctDataSequence
typedef sequence< TTeiVcnTTeiVcnSequence

Member Typedef Documentation

Sequence of the DCBM bit list. The DCBM is a 4096 bit list, which corresponds to VCNs 1 through 4096. If the bit is set, the the corresponding VCN data is 'defined'. If the bit is not set, the record in the VCM is to be ignored (but not cleared).

Frequency of the QAM carrier in Khz

Standard MPEG2 standard service number

Source ID is unique to each source.

Virtual channel numbers are 1..4096 in AQAM systems

Sequence to hold a list of VCNs

Sequence of TTeiVctData& structures. Each TTeiVctData is a record from the VCM


Member Enumeration Documentation

Virtual channel attribute.

Enumerator:
CHANNEL_ATTRIBUTE_NORMAL 

Channel attribute normal is searchable and viewable by the subscriber.

CHANNEL_ATTRIBUTE_HIDDEN 

Channel attribute hidden is not presented to the viewer in any guide screens, and is not directly tunable. It is used for background services on the QPSK or DOCSIS paths, and for VOD services.

The modulation scheme.

Enumerator:
UNKNOWN_MODULATION 

Unknown Modulation.

QPSK_MODULATION 

QPSK Modualtion.

BPSK_MODULATION 

BPSK Modulation.

QQPSK_MODULATION 

QQPSK Modulation.

VSB_8_MODULATION 

VSB8 Modulation.

VSB_16_MODULATION 

VSB16 Modulation.

QAM_16_MODULATION 

QAM16 Modulation.

QAM_32_MODULATION 

QAM32 Modulation.

QAM_64_MODULATION 

QAM64 Modulation.

QAM_80_MODULATION 

QAM80 Modulation.

QAM_96_MODULATION 

QAM96 Modulation.

QAM_112_MODULATION 

QAM112 Modulation.

QAM_128_MODULATION 

QAM128 Modulation.

QAM_160_MODULATION 

QAM160 Modulation.

QAM_192_MODULATION 

QAM192 Modulation.

QAM_224_MODULATION 

QAM224 Modulation.

QAM_256_MODULATION 

QAM256 Modulation.

QAM_320_MODULATION 

QAM320 Modulation.

QAM_384_MODULATION 

QAM384 Modulation.

QAM_448_MODULATION 

QAM448 Modulation.

QAM_512_MODULATION 

QAM512 Modulation.

QAM_640_MODULATION 

QAM640 Modulation.

QAM_768_MODULATION 

QAM768 Modulation.

QAM_896_MODULATION 

QAM896 Modulation.

QAM_1024_MODULATION 

QAM1024 Modulation.

Service types.

Enumerator:
SERVICE_TYPE_UNKNOWN 

Unknown service type.

SERVICE_TYPE_ANALOG 

For non-digital service type.

SERVICE_TYPE_MPEG2_DIGITAL 

MPEG2 service type, for all AQAM digital channels

Virtual channel tune types.

Enumerator:
TUNE_TYPE_QAM 

QAM based tune (triplet required).

TUNE_TYPE_IP 

IP or IP multitask tune.


Member Function Documentation

void ITeiChannelMapManagerService::GetApplicationId ( in TTeiVcn  vcn,
out long  appId 
) raises (TToiInvalidArgumentException)

Returns AppID based on VCN

Parameters:
vcn Channel virtual channel number.
Return values:
appId Channel App ID.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
void ITeiChannelMapManagerService::GetDcbm ( out TTeiDcbmSequence  dcbm  )  raises (TToiInvalidArgumentException)

Get defined channel bit map. DCBM provides the information about the defined virtual channels in the channel map.

Return values:
dcbm The sequence holding the DCBM bit array
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid. The length of the returned list is ALWAYS 4096 bits or 128 longs.
void ITeiChannelMapManagerService::GetSourceId ( in TTeiVcn  vcn,
out TTeiSourceId  sourceId 
) raises (TToiInvalidArgumentException)

Returns SourceID based on VCN

Parameters:
vcn Channel virtual channel number.
Return values:
sourceId Channel Source ID.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
void ITeiChannelMapManagerService::GetSourceIdFromSourceName ( in string  sourceName,
out TTeiSourceId  sourceId 
) raises (TToiInvalidArgumentException)

Mapping the SourceName to SourceID.

Parameters:
sourceName Channel name.
Return values:
sourceId Channel Source ID.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
void ITeiChannelMapManagerService::GetSourceName ( in TTeiSourceId  sourceId,
out string  sourceName 
) raises (TToiInvalidArgumentException)

Returns SourceName given a Source ID.

Parameters:
sourceId Channel Source ID.
Return values:
sourceName Channel name.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
void ITeiChannelMapManagerService::GetTuneType ( in TTeiVcn  vcn,
out TTeiTuneType  tuneType 
) raises (TToiInvalidArgumentException)

Returns the tuning mode of the VCN.

Parameters:
vcn Channel VCN.
Return values:
tuneType QAM or IP.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
void ITeiChannelMapManagerService::GetTuningParameters ( in TTeiVcn  vcn,
out TTeiTuningParameters  tuningParameters 
) raises (TToiInvalidArgumentException)

Get specific tuning parameters by VCN

Parameters:
vcn Virtual channel number.
Return values:
tuningParameters tuning parameter struct.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
void ITeiChannelMapManagerService::GetVctData ( in TTeiVcn  startVcn,
in long  requestedNumChannels,
out TTeiVctDataSequence  vctList 
) raises (TToiInvalidArgumentException)

Returns virtual channel data List (selected VCT Records).

Parameters:
startVcn The starting channel number to query.
requestedNumChannels Desired number of channels to return
Return values:
vctList The sequence of VCT Data.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid. Requested number of channels must never exceed the 8K IPC data limit.
Note:
this call does not include any IP (ICMP) channel types which may be associated with VCNs. It returns only QAM type channels.
void ITeiChannelMapManagerService::GetVirtualChannel ( in long  appId,
out TTeiVcn  vcn 
) raises (TToiInvalidArgumentException)

Get a VCN for an Application ID.

Parameters:
appId Channel App ID.
Return values:
vcn Virtual channel number.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
void ITeiChannelMapManagerService::GetVirtualChannels ( in TTeiSourceId  sourceId,
out TTeiVcnSequence  vcns 
) raises (TToiInvalidArgumentException)

Get the VCN list for SourceID.

Parameters:
sourceId Channel Source ID.
Return values:
vcns Virtual channel number list.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.