Adobe Experience Viewers HTML5 SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk.common

Class s7sdk.common.AudioCaptionsButton


Extends s7sdk.common.Button.

The AudioCaptionsButton is a button that is used to toggle multi audio multi caption menu.

Currently this component does not support any modifiers.

Defining Appearance using CSS

You can define the appearance of the AudioCaptionsButton component using CSS rules. All Adobe Experience Viewers HTML5 SDK components use class selectors for styling. You can style the body of the AudioCaptionsButton component by using the .s7audiocaptionsbutton class selector. The styles that are associated with this class selector are applied to all instances of the AudioCaptionsButton component. You can style particular instances by prefixing the class rule with the instance #id. For example, styling rules for #myComp.s7audiocaptionsbutton are applied only to the particular AudioCaptionsButton instance.

Localizable Symbols

AudioCaptionsButton also has text symbols that you can localize either in a preset or in the viewer page though the mechanisms provided by the ParameterManager. For more information on localization consult the ParameterManager API documentation and Adobe Experience Viewers HTML5 SDK User Guide.

SymbolDescription
AudioCaptionsButton.TOOLTIPTooltip text when both audio and captions are available
AudioCaptionsButton.TOOLTIP_AUDIOTooltip text when only audios are available
AudioCaptionsButton.TOOLTIP_SUBTITLETooltip text when only subtitles are available

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.common.AudioCaptionsButton(container, settings, compId)
Methods borrowed from class s7sdk.common.Button:
activate, addEventListener, blur, deactivate, dispose, focus, getHeight, getWidth, resize, setCSS, setLabel
Class Detail
s7sdk.common.AudioCaptionsButton(container, settings, compId)
Default styles for AudioCaptionsButton:

	.s7audiocaptionsbutton {
		width:25px;
		height:25px;
		background-size:contain;
		background-repeat:no-repeat;
		background-position:center;
		-webkit-touch-callout:none;
		-webkit-user-select:none;
		-moz-user-select:none;
		-ms-user-select:none;
		user-select:none;
		-webkit-tap-highlight-color:rgba(0,0,0,0);
	}
	.s7audiocaptionsbutton[state='up'] {
		background-image:url(images/sdk/audiocaptions_up.png);
	}
	.s7audiocaptionsbutton[state='over'] {
		background-image:url(images/sdk/audiocaptions_over.png);
	}
	.s7audiocaptionsbutton[state='down'] {
		background-image:url(images/sdk/audiocaptions_down.png);
	}
	.s7audiocaptionsbutton[state='disabled'] {
		background-image:url(images/sdk/audiocaptions_disabled.png);
	}
Parameters:
{String|Container} container
The reference to Container instance, ControlBar instance or the ID of the parent DOM element to which the component is added as a child
{s7sdk.ParameterManager} settings
A parameter manager instance that represents the desired configuration.
{String} compId
An optional parameter that specifies the ID of the component DOM element.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed May 15 2024 09:55:06 GMT-0000 (UTC)