Channel Information

An example of using the Channel Information global within the Python environment can be found in the Layout Tool Class example script called “”.

class lwsdk.LWChannelInfo(*args)

Bases: object

Proxy of C++ PCore::LWChannelInfo class

 channelEnvelope(LWChannelID chan) → LWEnvelopeID

Returns the underlying envelope for a channel. The envelope can be examined and modified using the Animation Envelopes global.

 channelEvaluate(LWChannelID chan, LWTime chantime) → double

Returns the value of the channel at the specified time.

 channelName(LWChannelID chan) → char

Returns the name of the channel.

 channelParent(LWChannelID chan) → LWChanGroupID

Returns the group ID to which a channel belongs.

 channelType(LWChannelID chan) → int

Returns the value type of the channel, which determines how the value is interpreted and displayed to the user. It can be one of the following:


 groupName(LWChanGroupID group) → char

Returns the name of the channel group.

 groupParent(LWChanGroupID group) → LWChanGroupID

Returns the parent group ID of a channel group.

 nextChannel(LWChanGroupID parent, LWChannelID chan) → LWChannelID

Returns the next channel in the group. If the previous chan is None, this returns the first channel in the group.

 nextGroup(LWChanGroupID parent, LWChanGroupID group) → LWChanGroupID

Returns the next channel group in the group list. If the parent is None, this returns groups from the root of the channel tree, and if the previous group is None, it returns the first group.

 server(LWChannelID chan, char cls, int idx) → char

Returns the name of a plug-in applied to the channel. The cls argument is the class string, which will often be lwsdk.LWCHANNEL_HCLASS, but may be others. The idx argument specifies the "slot," or position, in the server list, and counts from 1.

 serverApply(LWChannelID chan, char cls, char name, int flags) → int

Apply the plug-in to the channel. Returns the server list index, or 0 if it fails. The name is the server name, the string in the name field of the plug-in's ServerRecord. The flags can be any combination of those returned by LWChannelInfo::serverFlags().

 serverFlags(LWChannelID chan, char cls, int idx) → unsigned int

Returns flags for the plug-in applied to the channel. This is the channel-specific version of LWItemInfo::serverFlags() function.

 serverInstance(LWChannelID chan, char cls, int idx) → LWInstance

Returns an opaque pointer to the plug-in's instance data. This is the LWInstance created and used by the plug-in's LWInstanceFuncs callbacks.

 serverRemove(LWChannelID chan, char cls, char name, LWInstance inst)

Remove the plug-in from the channel. The inst argument is the value returned by LWItemInfo::serverInstance().

 setChannelEvent(LWChannelID chan, LWChanEventFunc func, void data) → int


Previous topic

Animation Envelopes

Next topic

Info Messages

This Page