Macros
#define	kDrmRetryMaxAttempts SHAKA_MAKE_STRING_("drm.retryParameters.maxAttempts")

#define	kDrmRetryBaseDelay SHAKA_MAKE_STRING_("drm.retryParameters.baseDelay")

#define	kDrmRetryBackoffFactor SHAKA_MAKE_STRING_("drm.retryParameters.backoffFactor")

#define	kDrmRetryFuzzFactor SHAKA_MAKE_STRING_("drm.retryParameters.fuzzFactor")

#define	kDrmRetryTimeout SHAKA_MAKE_STRING_("drm.retryParameters.timeout")

#define	kDelayLicenseRequestUntilPlayed SHAKA_MAKE_STRING_("drm.delayLicenseRequestUntilPlayed");

#define	kManifestRetryMaxAttempts SHAKA_MAKE_STRING_("manifest.retryParameters.maxAttempts")

#define	kManifestRetryBaseDelay SHAKA_MAKE_STRING_("manifest.retryParameters.baseDelay")

#define	kManifestRetryBackoffFactor SHAKA_MAKE_STRING_("manifest.retryParameters.backoffFactor")

#define	kManifestRetryFuzzFactor SHAKA_MAKE_STRING_("manifest.retryParameters.fuzzFactor")

#define	kManifestRetryTimeout SHAKA_MAKE_STRING_("manifest.retryParameters.timeout")

#define	kManifestDashClockSyncUri SHAKA_MAKE_STRING_("manifest.dash.clockSyncUri")

#define	kDashIgnoreDrmInfo SHAKA_MAKE_STRING_("manifest.dash.ignoreDrmInfo")

#define	kXlinkFailGracefully SHAKA_MAKE_STRING_("manifest.dash.xlinkFailGracefully")

#define	kDashDefaultPresentationDelay SHAKA_MAKE_STRING_("manifest.dash.defaultPresentationDelay")

#define	kStreamingRetryMaxAttempts SHAKA_MAKE_STRING_("streaming.retryParameters.maxAttempts")

#define	kStreamingRetryBaseDelay SHAKA_MAKE_STRING_("streaming.retryParameters.baseDelay")

#define	kStreamingRetryBackoffFactor SHAKA_MAKE_STRING_("streaming.retryParameters.backoffFactor")

#define	kStreamingRetryFuzzFactor SHAKA_MAKE_STRING_("streaming.retryParameters.fuzzFactor")

#define	kStreamingRetryTimeout SHAKA_MAKE_STRING_("streaming.retryParameters.timeout")

#define	kRebufferingGoal SHAKA_MAKE_STRING_("streaming.rebufferingGoal")

#define	kBufferingGoal SHAKA_MAKE_STRING_("streaming.bufferingGoal")

#define	kBufferBehind SHAKA_MAKE_STRING_("streaming.bufferBehind")

#define	kIgnoreTextStreamFailures SHAKA_MAKE_STRING_("streaming.ignoreTextStreamFailures")

#define	kAlwaysStreamText SHAKA_MAKE_STRING_("streaming.alwaysStreamText")

#define	kStartAtSegmentBoundary SHAKA_MAKE_STRING_("streaming.startAtSegmentBoundary")

#define	kSmallGapLimit SHAKA_MAKE_STRING_("streaming.smallGapLimit")

#define	kJumpLargeGaps SHAKA_MAKE_STRING_("streaming.jumpLargeGaps")

#define	kDurationBackoff SHAKA_MAKE_STRING_("streaming.durationBackoff")

#define	kAbrEnabled SHAKA_MAKE_STRING_("abr.enabled")

#define	kDefaultBandwidthEstimate SHAKA_MAKE_STRING_("abr.defaultBandwidthEstimate")

#define	kAbrSwitchInterval SHAKA_MAKE_STRING_("abr.switchInterval")

#define	kAbrUpgradeTarget SHAKA_MAKE_STRING_("abr.bandwidthUpgradeTarget")

#define	kAbrDowngradeTarget SHAKA_MAKE_STRING_("abr.bandwidthDowngradeTarget")

#define	kAbrMinWidth SHAKA_MAKE_STRING_("abr.restrictions.minWidth")

#define	kAbrMaxWidth SHAKA_MAKE_STRING_("abr.restrictions.maxWidth")

#define	kAbrMinHeight SHAKA_MAKE_STRING_("abr.restrictions.minHeight")

#define	kAbrMaxHeight SHAKA_MAKE_STRING_("abr.restrictions.maxHeight")

#define	kAbrMinPixels SHAKA_MAKE_STRING_("abr.restrictions.minPixels")

#define	kAbrMaxPixels SHAKA_MAKE_STRING_("abr.restrictions.maxPixels")

#define	kAbrMinBandwidth SHAKA_MAKE_STRING_("abr.restrictions.minBandwidth")

#define	kAbrMaxBandwidth SHAKA_MAKE_STRING_("abr.restrictions.maxBandwidth")

#define	kPreferredAudioLanguage SHAKA_MAKE_STRING_("preferredAudioLanguage")

#define	kPreferredTextLanguage SHAKA_MAKE_STRING_("preferredTextLanguage")

#define	kPreferredVariantRole SHAKA_MAKE_STRING_("preferredVariantRole")

#define	kPreferredTextRole SHAKA_MAKE_STRING_("preferredTextRole")

#define	kPreferredAudioChannelCount SHAKA_MAKE_STRING_("preferredAudioChannelCount")

#define	kMinWidth SHAKA_MAKE_STRING_("restrictions.minWidth")

#define	kMaxWidth SHAKA_MAKE_STRING_("restrictions.maxWidth")

#define	kMinHeight SHAKA_MAKE_STRING_("restrictions.minHeight")

#define	kMaxHeight SHAKA_MAKE_STRING_("restrictions.maxHeight")

#define	kMinPixels SHAKA_MAKE_STRING_("restrictions.minPixels")

#define	kMaxPixels SHAKA_MAKE_STRING_("restrictions.maxPixels")

#define	kMinBandwidth SHAKA_MAKE_STRING_("restrictions.minBandwidth")

#define	kMaxBandwidth SHAKA_MAKE_STRING_("restrictions.maxBandwidth")

#define	kPlayRangeStart SHAKA_MAKE_STRING_("playRangeStart")

#define	kPlayRangeEnd SHAKA_MAKE_STRING_("playRangeEnd")

Detailed Description

Constant names for configuration key values.

These variables contain the string constants for the configurations that the Player supports.

Macro Definition Documentation

§ kAbrDowngradeTarget

#define kAbrDowngradeTarget SHAKA_MAKE_STRING_("abr.bandwidthDowngradeTarget")

(number) The largest fraction of the estimated bandwidth we should use. We should downgrade to avoid this.

Definition at line 218 of file config_names.h.

§ kAbrEnabled

#define kAbrEnabled SHAKA_MAKE_STRING_("abr.enabled")

(boolean) Whether ABR is currently enabled.

Definition at line 203 of file config_names.h.

§ kAbrMaxBandwidth

#define kAbrMaxBandwidth SHAKA_MAKE_STRING_("abr.restrictions.maxBandwidth")

(number) The maximum total bandwidth in bit/sec that will be chosen by ABR; if none match the restrictions, ABR will choose a random track.

Definition at line 261 of file config_names.h.

§ kAbrMaxHeight

#define kAbrMaxHeight SHAKA_MAKE_STRING_("abr.restrictions.maxHeight")

(number) The maximum height of a video track that will be chosen by ABR; if none match the restrictions, ABR will choose a random track.

Definition at line 239 of file config_names.h.

§ kAbrMaxPixels

#define kAbrMaxPixels SHAKA_MAKE_STRING_("abr.restrictions.maxPixels")

(number) The maximum number of total pixels of a video track that will be chosen by ABR; if none match the restrictions, ABR will choose a random track.

Definition at line 251 of file config_names.h.

§ kAbrMaxWidth

#define kAbrMaxWidth SHAKA_MAKE_STRING_("abr.restrictions.maxWidth")

(number) The maximum width of a video track that will be chosen by ABR; if none match the restrictions, ABR will choose a random track.

Definition at line 229 of file config_names.h.

§ kAbrMinBandwidth

#define kAbrMinBandwidth SHAKA_MAKE_STRING_("abr.restrictions.minBandwidth")

(number) The minimum total bandwidth in bit/sec that will be chosen by ABR; if none match the restrictions, ABR will choose a random track.

Definition at line 256 of file config_names.h.

§ kAbrMinHeight

#define kAbrMinHeight SHAKA_MAKE_STRING_("abr.restrictions.minHeight")

(number) The minimum height of a video track that will be chosen by ABR; if none match the restrictions, ABR will choose a random track.

Definition at line 234 of file config_names.h.

§ kAbrMinPixels

#define kAbrMinPixels SHAKA_MAKE_STRING_("abr.restrictions.minPixels")

(number) The minimum number of total pixels of a video track that will be chosen by ABR; if none match the restrictions, ABR will choose a random track.

Definition at line 245 of file config_names.h.

§ kAbrMinWidth

#define kAbrMinWidth SHAKA_MAKE_STRING_("abr.restrictions.minWidth")

(number) The minimum width of a video track that will be chosen by ABR; if none match the restrictions, ABR will choose a random track.

Definition at line 224 of file config_names.h.

§ kAbrSwitchInterval

#define kAbrSwitchInterval SHAKA_MAKE_STRING_("abr.switchInterval")

(number) The minimum number of seconds between ABR switches.

Definition at line 208 of file config_names.h.

§ kAbrUpgradeTarget

#define kAbrUpgradeTarget SHAKA_MAKE_STRING_("abr.bandwidthUpgradeTarget")

(number) The fraction of the estimated bandwidth which we should try to use when upgrading.

Definition at line 213 of file config_names.h.

§ kAlwaysStreamText

#define kAlwaysStreamText SHAKA_MAKE_STRING_("streaming.alwaysStreamText")

(boolean) If true, always stream text tracks, regardless of whether or not they are shown.

Definition at line 182 of file config_names.h.

§ kBufferBehind

#define kBufferBehind SHAKA_MAKE_STRING_("streaming.bufferBehind")

(number) The maximum number of seconds of content that we will keep in buffer behind the playhead.

Definition at line 171 of file config_names.h.

§ kBufferingGoal

#define kBufferingGoal SHAKA_MAKE_STRING_("streaming.bufferingGoal")

(number) The number of seconds of content that we will attempt to buffer ahead of the playhead.

Definition at line 166 of file config_names.h.

§ kDashDefaultPresentationDelay

#define kDashDefaultPresentationDelay SHAKA_MAKE_STRING_("manifest.dash.defaultPresentationDelay")

(number) The default presentation delay to use if suggestedPresentationDelay is not found in the manifest.

Definition at line 123 of file config_names.h.

§ kDashIgnoreDrmInfo

#define kDashIgnoreDrmInfo SHAKA_MAKE_STRING_("manifest.dash.ignoreDrmInfo")

(boolean) Ignore any DRM info provided in the manifest and only use the info found in the media. This assumes that all standard key systems are supported.

Definition at line 112 of file config_names.h.

§ kDefaultBandwidthEstimate

#define kDefaultBandwidthEstimate SHAKA_MAKE_STRING_("abr.defaultBandwidthEstimate")

(number) The default estimate of the network bandwidth, in bit/sec.

Definition at line 205 of file config_names.h.

§ kDelayLicenseRequestUntilPlayed

#define kDelayLicenseRequestUntilPlayed SHAKA_MAKE_STRING_("drm.delayLicenseRequestUntilPlayed");

(boolean) Delay sending license requests until playback has started.

Definition at line 68 of file config_names.h.

§ kDrmRetryBackoffFactor

#define kDrmRetryBackoffFactor SHAKA_MAKE_STRING_("drm.retryParameters.backoffFactor")

(number) The multiplier for successive retry delays for license requests.

Definition at line 53 of file config_names.h.

§ kDrmRetryBaseDelay

#define kDrmRetryBaseDelay SHAKA_MAKE_STRING_("drm.retryParameters.baseDelay")

(number) The delay before the first retry for license requests, in milliseconds.

Definition at line 50 of file config_names.h.

§ kDrmRetryFuzzFactor

#define kDrmRetryFuzzFactor SHAKA_MAKE_STRING_("drm.retryParameters.fuzzFactor")

(number) The range (as a factor) to fuzz the delay amount for license requests. For example, 0.5 means 50% above and below.

Definition at line 59 of file config_names.h.

§ kDrmRetryMaxAttempts

#define kDrmRetryMaxAttempts SHAKA_MAKE_STRING_("drm.retryParameters.maxAttempts")

(number) The maximum number of requests that will be made for license requests.

Definition at line 44 of file config_names.h.

§ kDrmRetryTimeout

#define kDrmRetryTimeout SHAKA_MAKE_STRING_("drm.retryParameters.timeout")

(number) The request timeout for license requests, in milliseconds. Zero means no timeout.

Definition at line 65 of file config_names.h.

§ kDurationBackoff

#define kDurationBackoff SHAKA_MAKE_STRING_("streaming.durationBackoff")

(number) The number of seconds to adjust backward when seeking to exactly the duration.

Definition at line 200 of file config_names.h.

§ kIgnoreTextStreamFailures

#define kIgnoreTextStreamFailures SHAKA_MAKE_STRING_("streaming.ignoreTextStreamFailures")

(boolean) If true, the player will ignore text stream failures and continue playing other streams.

Definition at line 176 of file config_names.h.

§ kJumpLargeGaps

#define kJumpLargeGaps SHAKA_MAKE_STRING_("streaming.jumpLargeGaps")

(boolean) If true, jump large gaps in addition to small gaps.

Definition at line 195 of file config_names.h.

§ kManifestDashClockSyncUri

#define kManifestDashClockSyncUri SHAKA_MAKE_STRING_("manifest.dash.clockSyncUri")

(string) The URI to fetch for Live clock-synchronization if none is provided in the manifest.

Definition at line 105 of file config_names.h.

§ kManifestRetryBackoffFactor

#define kManifestRetryBackoffFactor SHAKA_MAKE_STRING_("manifest.retryParameters.backoffFactor")

(number) The multiplier for successive retry delays for manifest requests.

Definition at line 86 of file config_names.h.

§ kManifestRetryBaseDelay

#define kManifestRetryBaseDelay SHAKA_MAKE_STRING_("manifest.retryParameters.baseDelay")

(number) The delay before the first retry for manifest requests, in milliseconds.

Definition at line 81 of file config_names.h.

§ kManifestRetryFuzzFactor

#define kManifestRetryFuzzFactor SHAKA_MAKE_STRING_("manifest.retryParameters.fuzzFactor")

(number) The range (as a factor) to fuzz the delay amount for manifest requests. For example, 0.5 means 50% above and below.

Definition at line 92 of file config_names.h.

§ kManifestRetryMaxAttempts

#define kManifestRetryMaxAttempts SHAKA_MAKE_STRING_("manifest.retryParameters.maxAttempts")

(number) The maximum number of requests that will be made for manifest requests.

Definition at line 75 of file config_names.h.

§ kManifestRetryTimeout

#define kManifestRetryTimeout SHAKA_MAKE_STRING_("manifest.retryParameters.timeout")

(number) The request timeout for manifest requests, in milliseconds. Zero means no timeout.

Definition at line 98 of file config_names.h.

§ kMaxBandwidth

#define kMaxBandwidth SHAKA_MAKE_STRING_("restrictions.maxBandwidth")

(number) The maximum total bandwidth in bit/sec that can be played.

Definition at line 296 of file config_names.h.

§ kMaxHeight

#define kMaxHeight SHAKA_MAKE_STRING_("restrictions.maxHeight")

(number) The maximum height of a video track that can be played.

Definition at line 282 of file config_names.h.

§ kMaxPixels

#define kMaxPixels SHAKA_MAKE_STRING_("restrictions.maxPixels")

(number) The maximum number of total pixels of a video track that can be played.

Definition at line 292 of file config_names.h.

§ kMaxWidth

#define kMaxWidth SHAKA_MAKE_STRING_("restrictions.maxWidth")

(number) The maximum width of a video track that can be played.

Definition at line 278 of file config_names.h.

§ kMinBandwidth

#define kMinBandwidth SHAKA_MAKE_STRING_("restrictions.minBandwidth")

(number) The minimum total bandwidth in bit/sec that can be played.

Definition at line 294 of file config_names.h.

§ kMinHeight

#define kMinHeight SHAKA_MAKE_STRING_("restrictions.minHeight")

(number) The minimum height of a video track that can be played.

Definition at line 280 of file config_names.h.

§ kMinPixels

#define kMinPixels SHAKA_MAKE_STRING_("restrictions.minPixels")

(number) The minimum number of total pixels of a video track that can be played.

Definition at line 287 of file config_names.h.

§ kMinWidth

#define kMinWidth SHAKA_MAKE_STRING_("restrictions.minWidth")

(number) The minimum width of a video track that can be played.

Definition at line 276 of file config_names.h.

§ kPlayRangeEnd

#define kPlayRangeEnd SHAKA_MAKE_STRING_("playRangeEnd")

(number) The end of restricted seek range, in seconds.

Definition at line 301 of file config_names.h.

§ kPlayRangeStart

#define kPlayRangeStart SHAKA_MAKE_STRING_("playRangeStart")

(number) The start of restricted seek range, in seconds.

Definition at line 299 of file config_names.h.

§ kPreferredAudioChannelCount

#define kPreferredAudioChannelCount SHAKA_MAKE_STRING_("preferredAudioChannelCount")

(number) The preferred number of audio channels.

Definition at line 272 of file config_names.h.

§ kPreferredAudioLanguage

#define kPreferredAudioLanguage SHAKA_MAKE_STRING_("preferredAudioLanguage")

(string) The preferred language to use for audio tracks.

Definition at line 264 of file config_names.h.

§ kPreferredTextLanguage

#define kPreferredTextLanguage SHAKA_MAKE_STRING_("preferredTextLanguage")

(string) The preferred language to use for text tracks.

Definition at line 266 of file config_names.h.

§ kPreferredTextRole

#define kPreferredTextRole SHAKA_MAKE_STRING_("preferredTextRole")

(string) The preferred role to use for text tracks.

Definition at line 270 of file config_names.h.

§ kPreferredVariantRole

#define kPreferredVariantRole SHAKA_MAKE_STRING_("preferredVariantRole")

(string) The preferred role to use for variant tracks.

Definition at line 268 of file config_names.h.

§ kRebufferingGoal

#define kRebufferingGoal SHAKA_MAKE_STRING_("streaming.rebufferingGoal")

(number) The minimum number of seconds of content that must buffer before we can begin playback or can continue playback after we enter into a buffering state.

Definition at line 161 of file config_names.h.

§ kSmallGapLimit

#define kSmallGapLimit SHAKA_MAKE_STRING_("streaming.smallGapLimit")

(number) The limit (in seconds) for a gap in the media to be considered "small". Small gaps are jumped automatically without events.

Definition at line 193 of file config_names.h.

§ kStartAtSegmentBoundary

#define kStartAtSegmentBoundary SHAKA_MAKE_STRING_("streaming.startAtSegmentBoundary")

(boolean) If true, adjust the start time backwards so it is at the start of a segment.

Definition at line 187 of file config_names.h.

§ kStreamingRetryBackoffFactor

#define kStreamingRetryBackoffFactor SHAKA_MAKE_STRING_("streaming.retryParameters.backoffFactor")

(number) The multiplier for successive retry delays for segment requests.

Definition at line 141 of file config_names.h.

§ kStreamingRetryBaseDelay

#define kStreamingRetryBaseDelay SHAKA_MAKE_STRING_("streaming.retryParameters.baseDelay")

(number) The delay before the first retry for segment requests, in milliseconds.

Definition at line 136 of file config_names.h.

§ kStreamingRetryFuzzFactor

#define kStreamingRetryFuzzFactor SHAKA_MAKE_STRING_("streaming.retryParameters.fuzzFactor")

(number) The range (as a factor) to fuzz the delay amount for segment requests. For example, 0.5 means 50% above and below.

Definition at line 147 of file config_names.h.

§ kStreamingRetryMaxAttempts

#define kStreamingRetryMaxAttempts SHAKA_MAKE_STRING_("streaming.retryParameters.maxAttempts")

(number) The maximum number of requests that will be made for segment requests.

Definition at line 130 of file config_names.h.

§ kStreamingRetryTimeout

#define kStreamingRetryTimeout SHAKA_MAKE_STRING_("streaming.retryParameters.timeout")

(number) The request timeout for segment requests, in milliseconds. Zero means no timeout.

Definition at line 153 of file config_names.h.

§ kXlinkFailGracefully

#define kXlinkFailGracefully SHAKA_MAKE_STRING_("manifest.dash.xlinkFailGracefully")

(boolean) If true, xlink failures will result in using the existing content in the tag; if false, xlink failures result in manifest parsing errors.

Definition at line 117 of file config_names.h.

Macros