ChannelDescriptorBuilder
Builder that creates an instance of the ChannelDescriptor object.
Extends
Constructors
new ChannelDescriptorBuilder()
new ChannelDescriptorBuilder():
ChannelDescriptorBuilder
Returns
Inherited from
Methods
build()
build():
IChannelDescriptor
Builds the ChannelDescriptor object from the fields in the ChannelDescriptorBuilder object.
Returns
The built ChannelDescriptor object.
Throws
InvalidArgumentError if one or more of the required fields are missing.
Throws
IllegalStateError if the function is called after this builder instance
has already built an object once.
Overrides
identifier()
identifier(
identifier):ChannelDescriptorBuilder
Sets the Identifier of the ChannelDescriptor.
Parameters
identifier
string
A string that represents a unique identifier for the channel. This identifier should be unique across all channels within the application package. This field has a maximum length of 8192 bytes.
Returns
The ChannelDescriptorBuilder object with channel Identifier set.
Details
This field is required for the channel descriptor.
Throws
IllegalStateError if the function is called after this builder instance
has already built an object once.
Throws
InvalidArgumentError if the field exceeds the maximum length of 8192 bytes.
Throws
InvalidArgumentError if a string that is not valid UTF-8 is passed in.
majorNumber()
majorNumber(
majorNumber):ChannelDescriptorBuilder
Sets the MajorNumber of the ChannelDescriptor.
Parameters
majorNumber
number
The major number 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
The ChannelDescriptorBuilder object with channel MajorNumber set.
Details
This field is required for the channel descriptor.
Throws
IllegalStateError if the function is called after this builder instance
has already built an object once.
minorNumber()
minorNumber(
minorNumber):ChannelDescriptorBuilder
Sets the MinorNumber of the ChannelDescriptor.
Parameters
minorNumber
number
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
The ChannelDescriptorBuilder object with channel MinorNumber set.
Details
This field is required for the channel descriptor.
Throws
IllegalStateError if the function is called after this builder instance
has already built an object once.
Last updated: Sep 30, 2025
