FLVPlaybackCaptioning  - AS3

Determina si el componente FLVPlaybackCaptioning mueve y cambia automáticamente el tamaño del objeto TextField para texto.

Si la propiedad autoLayout se establece como true, la instancia DisplayObject o el objeto TextField que contiene el texto muestra 10 píxeles desde la parte inferior de la instancia FLVPlayback. El área de texto cubre la anchura de la instancia FLVPlayback, y se mantiene un margen de 10 píxeles a cada lado.

Si esta propiedad está establecida como true, la instancia DisplayObject o el objeto TextField se muestra directamente sobre la instancia FLVPlayback. Si crea un objeto TextField propio, se recomienda que establezca autoLayout como false. Si wordWrap = false, el área de texto se centra sobre la instancia FLVPlayback, pero puede ser más amplia que la instancia FLVPlayback.

Para controlar el diseño, es necesario que detecte el evento captionChange para determinar cuándo se crea la instancia de objeto TextField.

El valor predeterminado es true.

Elementos de API relacionados

Define la instancia del componente CaptionButton de la interfaz personalizada FLVPlayback, que proporciona capacidades de conmutación para activar y desactivar el texto.

La propiedad captionButton funciona de forma similar a las propiedades de FLVPlayback playButton, pauseButton, muteButton, etc.

Elementos de API relacionados

Establece la instancia DisplayObject en la que mostrar el texto.

Si establece la instancia como un objeto TextField, será directamente el destino. Si establece la instancia como un contenedor DisplayObjectContainer que contiene uno o varios objetos TextField, el texto se muestra en el objeto TextField con el índice de visualización más bajo.

El método DisplayObjectContainer admite un objeto similar a un clip de película con un fondo de escala 9, que se puede escalar cuando el objeto TextField cambia de tamaño.

Para una escala y dibujo más complejos, escriba código para que el método DisplayObjectContainer detecte un evento captionChange.

Nota: si no se establece la propiedad captionTargetName o captionTarget, la instancia FLVPlaybackCaptioning crea un campo de texto establecido por la propiedad captionTarget con este formato:

• fondo negro (background = true; backgroundColor = 0x000000;)
• texto blanco (textColor = 0xFFFFFF)
• autoSize = TextFieldAutoSize.LEFT
• multiLine = true
• wordWrap = true
• font = "_sans"
• size = 12

Para personalizar estos valores, detecte el evento captionTargetCreated.

Elementos de API relacionados

Nombre de la instancia del objeto TextField o clip de película en el que está contenido un objeto Textfield que contiene el texto.

Para no especificar destino, establezca esta propiedad como una cadena vacía (es decir, sin destino especificado) o auto. Esta propiedad se utiliza principalmente en el inspector de componentes. Si escribe código, utilice la propiedad captionTarget en su lugar.

El valor predeterminado es auto.

Elementos de API relacionados

Establece la instancia de FLVPlayback para que muestre texto. La instancia de FLVPlayback debe tener el mismo elemento principal que la instancia de FLVPlaybackCaptioning.

Si la propiedad flvPlaybackName o flvPlayback no está establecida, la instancia de FLVPlaybackCaptioning buscará una instancia de FLVPlayback con el mismo elemento principal y texto que la primera que encuentra.

Elementos de API relacionados

Establezca el nombre de la instancia de FLVPlayback que desea que muestre texto.

Para no especificar destino, establezca esta propiedad como una cadena vacía o auto. La instancia de FLVPlayback debe tener el mismo elemento principal que la instancia de FLVPlaybackCaptioning.

El nombre de instancia de FLVPlayback se utiliza principalmente en el inspector de componentes. Si escribe código, utilice la propiedad flvPlayback.

Si no se establece la propiedad flvPlaybackName o flvPlayback o está establecida como auto, la instancia de FLVPlaybackCaptioning busca una instancia de FLVPlayback con el mismo elemento principal y texto que la primera que encuentra.

El valor predeterminado es auto.

Elementos de API relacionados

Se utiliza para mostrar texto; true = muestra texto, false = no muestra texto.

Si utiliza la propiedad captionButton para permitir que el usuario pueda activar y desactivar texto, establezca la propiedad showCaptions como false.

El valor predeterminado es true.

Elementos de API relacionados

Limita las instrucciones de formato del archivo de texto temporizado cuando está establecida como true.

Los estilos siguientes no se admiten si la propiedad simpleFormatting está establecida como true:

• tts:backgroundColor
• tts:color
• tts:fontSize
• tts:fontFamily
• tts:wrapOption

Los estilos siguientes se admiten si la propiedad simpleFormatting está establecida como true:

• tts:fontStyle
• tts:fontWeight
• tts:textAlign

URL del archivo XML de texto temporizado que contiene información de texto (propiedad necesaria).

Admite pistas en varios idiomas.

El mejor uso de la propiedad track es admitir pistas de varios idiomas con puntos de referencia incorporados.

Debe utilizar los formatos admitidos para los puntos de referencia de FLVPlaybackCaptioning.

Si la propiedad track se establece con un valor distinto a 0, el componente FLVPlaybackCaptioning busca una propiedad text<n> en el punto de referencia, donde n es el valor de la pista.

Por ejemplo, si track == 1, el componente FLVPlayBackCaptioning busca el parámetro text1 en el punto de referencia. Si no se encuentra ningún parámetro coincidente, se utiliza la propiedad de texto del parámetro del punto de referencia.

El valor predeterminado es 0.

Conecta el texto con un elemento VideoPlayer específico en el componente FLVPlayback.

Si desea utilizar texto en varios reproductores de vídeo (con las propiedades activeVideoPlayerIndex y visibleVideoPlayerIndex del componente FLVPlayback), debería crear una instancia del componente FLVPlaybackCaptioning para cada VideoPlayer que utilice y establecer este propiedad para que se corresponda con el índice.

El valor predeterminado del índice VideoPlayer es 0 cuando sólo se utiliza un reproductor de vídeo.

Elementos de API relacionados

Crea una nueva instancia FLVPlaybackCaptioning.

Devuelve un conjunto de puntos de referencia del componente FLVPlayback cuyo texto contiene la cadena que se busca.

Parámetros

Devuelve un conjunto de puntos de referencia del componente FLVPlayback que contienen el texto.

Devuelve una cadena que contiene todo el texto como transcripción en formato HTML.

Cada texto se incluye en una etiqueta p con el atributo class "fl_video_caption", un atributo id exclusivo que comienza con la cadena "fl_video_caption_2_0_" y un atributo title que indica el código de tiempos en el que el texto aparece en el vídeo.

A continuación se muestra un breve ejemplo del HTML devuelto:

		 <div id="fl_video_transcript" class="fl_video_transcript">
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_1" title="0:00.50"><i>( speaking French ): </i><br/><b>George: </b> Bonjour, Marie.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_2" title="0:01.75"><b>Marie: </b> Bonjour, George.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_3" title="0:03.75">VoilÀ une sucette.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_4" title="0:05.50"><b>George: </b> C'est pour moi?</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_5" title="0:06.50"><b>Marie: </b> Oui, c'est pour toi.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_6" title="0:08.00"><b>George: </b> Merci, Marie!</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_7" title="0:09.50"><b>Marie: </b> De rien, George.</p>
		 </div>
		 

Parámetros

Devuelve un número de segundos como cadena de código de tiempo.

Parámetros

Se distribuye al añadir o eliminar texto en el campo de texto de destino de texto.

El evento también se distribuye si las condiciones siguientes son true:

• la propiedad captionTargetName no está establecida
• la propiedad captionTarget no está establecida
• la instancia FLVPlaybackCaptioning crea automáticamente un objeto TextField para texto.

El evento captionChange tiene la constante CaptionChangeEvent.CAPTION_CHANGE.

Este evento tiene las propiedades siguientes:

Elementos de API relacionados

Se distribuye después de crear la propiedad captionTarget, pero antes de añadir texto (la propiedad captionTarget está vacía).

Si la propiedad captionTarget está establecida con un objeto DisplayObject personalizado, o si la propiedad captionTargetName está establecida, este evento no se distribuye.

Detecte este evento si está personalizando las propiedades del objeto TextField, por ejemplo, defaultTextFormat.

El evento captionChange tiene la constante CaptionChangeEvent.CAPTION_CHANGE.

Este evento tiene las propiedades siguientes:

Elementos de API relacionados

Se distribuye tras la carga de todos los datos XML de texto temporizado.

Este evento tiene las propiedades siguientes:

Elementos de API relacionados

Se distribuye si una llamada al evento URLLoader.load() intenta acceder a un archivo XML de texto temporizado sobre HTTP y si el entorno de Flash Player actual puede detectar y devolver el código de estado para la petición.

Este evento tiene las propiedades siguientes:

Elementos de API relacionados

Se distribuye si una llamada al evento URLLoader.load() genera un error grave que termina la descarga del archivo XML de texto temporizado.

Si este evento no se gestiona, emitirá un error.

Este evento tiene las propiedades siguientes:

Elementos de API relacionados

Se distribuye cuando comienza la operación de descarga para cargar el archivo XML de texto temporizado, tras una llamada al método URLLoader.load().

Este evento tiene las propiedades siguientes:

Elementos de API relacionados

Se distribuye al recibirse datos mientras progresa la descarga del archivo XML de texto temporizado.

Este evento tiene las propiedades siguientes:

Elementos de API relacionados

Se distribuye si se intenta llamar al evento URLLoader.load() para cargar un archivo XML de texto temporizado de un servidor situado fuera del entorno limitado de seguridad.

Si este evento no se gestiona, emitirá un error.

Este evento tiene las propiedades siguientes:

Elementos de API relacionados

Variable de estado que indica la versión corta del número del componente. El número de la versión resulta útil cuando se dispone de un archivo FLA y es necesario conocer la versión del componente. Para determinar la versión del componente, escriba el siguiente código en el archivo FLA:

trace (FLVPlaybackCaptioning.SHORT_VERSION);

La variable SHORT_VERSION sólo incluye las versiones superior e inferior, por ejemplo, 2.0. La variable version incluye los números de versión superior e inferior, así como los números de revisión y compilación, por ejemplo, 2.0.0.xx.

Elementos de API relacionados

Variable de estado que indica la versión larga del número del componente. El número de la versión resulta útil cuando se dispone de un archivo FLA y es necesario conocer la versión del componente. Para determinar la versión del componente, escriba el siguiente código en el archivo FLA:

trace (FLVPlaybackCaptioning.VERSION);

La variable VERSION incluye los números de versión superior e inferior, así como los números de revisión y compilación, por ejemplo, 2.0.0.xx. La variable SHORT_VERSION sólo incluye las versiones superior e inferior, por ejemplo, 2.0.

Elementos de API relacionados

Para realizar el ejemplo, siga estos pasos:

1. Abra un nuevo archivo de Flash (ActionScript 3.0).
2. Coloque el componente FLVPlayback en el escenario en la posición 0,0 y asígnele el nombre de instancia player.
3. Coloque el componente FLVPlaybackCaptioning en el escenario en la posición 0,0 y asígnele el nombre de instancia captioning.
4. Coloque el componente CaptionButton en el escenario.
5. Guarde el archivo FLA y asígnele un nombre, por ejemplo, captionEx.
6. Abra un nuevo archivo de ActionScript.
7. Pegue el siguiente código de ejemplo de clase en un nuevo archivo de ActionScript y guárdelo como FLVPlaybackCaptioningExample.as en el mismo directorio que su archivo FLA.
8. En el archivo FLA (por ejemplo, captionEx), defina la entrada de la clase Document en el inspector de propiedades como FLVPlaybackCaptioningExample.
9. Seleccione Control > Probar película.

package
{
    import fl.video.CaptionChangeEvent;
    import fl.video.FLVPlayback;
    import fl.video.FLVPlaybackCaptioning;
    import flash.display.Sprite;
    import flash.text.TextField;
    
    public class FLVPlaybackCaptioningExample extends Sprite {

        private var videoPath:String = "http://www.helpexamples.com/flash/video/caption_video.flv";
        private var captioningPath:String = "http://www.helpexamples.com/flash/video/caption_video.xml";
        
        public function FLVPlaybackCaptioningExample() {
            player.source = videoPath;
            player.skin = "SkinOverAllNoCaption.swf";
            player.skinBackgroundColor = 0x666666;
            player.skinBackgroundAlpha = 0.5;

            captioning.flvPlayback = player;
            captioning.source = captioningPath;
            captioning.autoLayout = false;            
            captioning.addEventListener(CaptionChangeEvent.CAPTION_CHANGE, onCaptionChange);
        }

        private function onCaptionChange(e:CaptionChangeEvent):void {
            var tf:* = e.target.captionTarget;
            var player:FLVPlayback = e.target.flvPlayback;

            // move the caption below the video
            tf.y = 210;            
        }
    }
}