• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

Task and System Property Definitions for Media Producer

Task and system Properties

task Property names that can be used to control the behavior of the Media Producer. Properties must be set before opening the Media Producer via the IToiMediaProducer::AssignTask() call. This call allows the application to customize the Media Producer for both remote and local producer functionality.

TToiTaskPropertyId Name Task Property Description TToiTaskPropertyId Value
PROPERTY_TASK_DRM_TYPE Property that defines the drm protocol to be used for media content protection. This task property must be set when assigning tasks. "task.drm.type"
PROPERTY_TASK_CLIENT_MAC_ADDRESS Property that defines the remote client device MAC address. This task property must be set for remote streaming. "task.client.macaddress"
PROPERTY_TASK_MEDIA_PROFILE Property that defines the media profile. This is used for scenarios where the application is requesting the platform to transcode the media source. This is an optional task property. "task.media.profile"
PROPERTY_TASK_TRANSCODING_AUDIO_LANGUAGE Property that defines the audio language to be used. This is used for scenarios where the application is requesting the platform to transcode the media source. This is an optional task property. If this task property is not set, then the first language is selected. "task.transcoding.audiolanguage"
PROPERTY_TASK_TRANSCODING_SUBTITLE_LANGUAGE Property that defines the subtitle language to be used. This is used for scenarios where the application is requesting the platform to transcode the media source. This is an optional task property. If this task property is not set, then the first language is selected. "task.transcoding.subtitlelanguage"
PROPERTY_TASK_TRANSCODING_DVS_ENABLED Property that enables DVS. This is an optional task property. If this task property is not set, then DVS is not enabled. "task.transcoding.dvsenabled"
PROPERTY_TASK_LOCAL_ASSET_ID Property that identifies the local asset id that should be used by the platform to store media content while in the producing state. This task property must be set for local produced assets. "task.local.assetid."

Task Property Content Protection Value Definitions

This selects the Media Producer's content protection protocol. This task property must be set when assigning tasks or an error will be returned.

PROPERTY_TASK_DRM_TYPE Name Content Protection Protocol Description TASKPROPERTY_DRM_TYPE Value
DTCPIP_DRM_TYPE This identifies the DTCIP content protection distribution protocol to be used. "dtcpip.distribution.drm.type"

Remote Distribution IP Client MAC Address Definitions

This provides the IP Client's MAC Address to streaming content IP Clients. This property must be set for content streaming to begin; an error will be returned if the task property sequence does not include this property.

PROPERTY_TASK_CLIENT_MAC_ADDRESS Name Distribution Content IP Client MAC Address Definition PROPERTY_TASK_CLIENT_MAC_ADDRESS Value
Not Applicable The string value can utilize two standard string based formats which use either ":" or "-" as the byte delimiters. For example: "00:1F:29:79:5A:52" or "00-1F-29-79-5A-52" For the hex decimals, it doesn't matter if they are upper or lower case. string value

Distribution Transcoding Media Profile Definitions

This provides the media profile to transcode the input media format to prior to streaming content IP Clients. Please see DLNA Networked Device Inoperability Guidelines for more details on the DLNA related formats

PROPERTY_TASK_TRANSCODING_MEDIA_PROFILE Name PROPERTY_TASK_TRANSCODING_MEDIA_PROFILE Value
Not Applicable "VGA_640x480_30_AAC-LC_96kbps_2CH" string value
Not Applicable "AVC_TS_HD_60_AC3_X_T" string value
Not Applicable "AVC_TS_HD_50_AC3_X_T" string value
Not Applicable "AVC_TS_HD_50_AC3_X_T" string value
Not Applicable "AVC_TS_HD_24_AC3_X_T" string value
Not Applicable "AVC_TS_HD_60_LPCM_X_T" string value
Not Applicable "AVC_TS_HD_50_LPCM_X_T" string value
Not Applicable "AVC_TS_HD_24_LPCM_X_T" string value
Not Applicable "AVC_MP4_BL_CIF15_HEAACv2_350" string value
Not Applicable "AVC_MP4_BL_CIF15_AAC_350" string value
Not Applicable "AVC_MP4_BL_CIF15_HEAAC_350" string value
Not Applicable "AVC_MP4_MP_SD_AAC_LC" string value
Not Applicable "AVC_MP4_BL_L31_HD_AAC" string value
Not Applicable "AVC_MP4_BL_L32_HD_AAC" string value
Not Applicable "MPEG_TS_HD_X_60_L2_T" string value
Not Applicable "MPEG_TS_HD_X_60_L2_ISO" string value
Not Applicable "MPEG_TS_HD_X_50_L2_T" string value
Not Applicable "MPEG_TS_HD_X_50_L2_ISO" string value
Not Applicable "AAC_ADTS_192" string value
Not Applicable "AAC_ISO_192" string value
Not Applicable "HEAACv2_L2_128" string value
Not Applicable "HEAACv2_ISO_128" string value
Not Applicable "WMALSL" string value
Not Applicable "WMALSL_MULT5" string value

Distribution Content Audio Transcoding Language Definitions

This selects the Content Audio Transcoding Language to be used to distribute content to IP Clients. The default value will be set to "eng" if this property is not set

PROPERTY_TASK_TRANSCODING_AUDIO_LANG Name Distribution Content Audio Language Definitions PROPERTY_TASK_TRANSCODING_AUDIO_LANG Value
Not Applicable This identifies the audio content transcoding language. The Distribution Content Audio Language string definitions which affects the audio language component selection for transcoding prior to streaming content to IP Clients. Please note: the input string will follow the ISO639-3 standard format. string value

Distribution Content Subtitle Transcoding Language Definitions

This selects the Content Subtitle Transcoding Language to be used to distribute content to IP Clients. The default value will be set to "eng" if this property is not set

PROPERTY_TASK_TRANSCODING_SUBTITLE_LANG Name Distribution Content Subtitle Language Definitions PROPERTY_TASK_TRANSCODING_SUBTITLE_LANG Value
Not Applicable This identifies the subtitle content transcoding language. The distribution content subtitle language string definitions which affects the audio language component selection for transcoding prior to streaming content to IP Clients. Please note: the input string will follow the ISO639-3 standard format. string value

Distribution Content Audio Transcoding DVS Enabled Definitions

This selects the Content Audio Transcoding DVS Enabled definition which affects the audio language component selection for transcoding prior to streaming content IP Clients. The default mode for audio transcoding language selection is DVS DISABLED if this property is not set.

PROPERTY_TASK_TRANSCODING_DVS_ENABLED Name Distribution Content Audio Transcoding DVS Enabled Type Definition PROPERTY_TASK_TRANSCODING_DVS_ENABLED Value
TRUE This value will enable the audio content transcoding dvs enabled audio language selection mode. "TRUE"
FALSE This value will disable the audio content transcoding dvs enabled audio language selection mode. "FALSE"

5.1.p5

Copyright (c) 2017 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.