Interface IChannelDescriptorBuilder
interface IChannelDescriptorBuilder
Extends com.amazon.apmf.IStandard
Builder that will create the ChannelDescriptor object
Methods
identifier()
Sets the identifier string of the channel builder and returns an instance of the builder.IChannelDescriptorBuilder*identifier(stringidentifier)
Parameters
identifier
string — Required
A string that represents a unique identifier for the channel.
This identifier should be unique across all channels within the application package.
This field is mandatory and has a maximum length of 8192.
Returns
IChannelDescriptorBuilder*
The ChannelDescriptorBuilder object with channel identifier set.
Throws
IllegalStateError— if the function is called after this builder instance has already built an object once.InvalidArgumentError— if the field exceeds maximum length of 8192.
majorNumber()
Sets the major number of the channel builder and returns an instance of the builder.IChannelDescriptorBuilder*majorNumber(i32majorNumber)
Parameters
majorNumber
i32 — Required
A number that indicates the channel major number value (for example, using ATSC format).
When the channel number is expressed as a string, such as “13.1” or “256”, the major number would be
13 or 256, respectively. This field should be set to 0 for channels that are not represented by a major or minor number.
Returns
IChannelDescriptorBuilder*
The ChannelDescriptorBuilder object with majorNumber set.
Throws
IllegalStateError— if the function is called after this builder instance has already built an object once.
minorNumber()
Sets the minor number of the channel builder and returns an instance of the builder.IChannelDescriptorBuilder*minorNumber(i32minorNumber)
Parameters
minorNumber
i32 — Required
The minor number indicates the channel minor number value (for example, using ATSC format).
When the channel number is expressed as a string, such as “13.1” or “256”, the minor number would be
1 or 0, respectively. This field should be set to 0 for channels that are not represented by a major or minor number.
Returns
IChannelDescriptorBuilder*
The ChannelDescriptorBuilder object with minorNumber set.
Throws
IllegalStateError— if the function is called after this builder instance has already built an object once.
build()
Builds and returns a pointer to an instance of theIChannelDescriptor*build()
IChannelDescriptor object.
This function should be called after the desired fields of the channel descriptor
builder have been set using the other builder functions. The build() function should
only be called once per builder object.
Returns
IChannelDescriptor*
An instance of a ChannelDescriptor object with all of the data that was set.
Throws
InvalidArgumentError— if one or more of the required fields are not provided to the builder.IllegalStateError— if the function is called after this builder instance has already built an object once.
