FLVPlaybackCaptioning  - AS3

Determina se o componente FLVPlaybackCaptioning move e redimensiona automaticamente o objeto TextField para colocação de legendas.

Se a propriedade autoLayout estiver configurada como true, a ocorrência DisplayObject ou o objeto TextField que contêm as legendas possuem 10 pixels a partir da parte inferior da ocorrência FLVPlayback. A área das legendas cobre a largura da ocorrência FLVPlayback, mantendo uma margem de 10 pixels em cada lado.

Quando esta propriedade estiver definida como true, a ocorrência DisplayObject ou o objeto TextField é exibido diretamente sobre a ocorrência FLVPlayback. Se você estiver criando seu próprio objeto TextField, você deve configurar autoLayout como false. Se wordWrap = falso, a área de legendagem é centralizada na ocorrência FLVPlayback, mas pode ser mais ampla do que a ocorrência FLVPlayback.

Para controlar o layout, você precisar ouvir o evento captionChange para determinar quando for criada a ocorrência do objeto TextField.

O valor padrão é true.

Elementos da API relacionados

Define a ocorrência de componente de UI personalizada de captionButton FLVPlayback que fornece recursos de alternância para ativar e desativar a colocação de legendas.

A propriedade captionButton funciona de forma semelhante às propriedades FLVPlayback playButton, pauseButton, muteButton e assim por diante.

Elementos da API relacionados

Define a ocorrência de DisplayObject na qual exibir legendas.

Se você define a ocorrência como objeto TextField, ela é focalizada diretamente. Se você configura a ocorrência como DisplayObjectContainer que contém um ou mais objetos TextField, as legendas são exibidas no objeto TextField com o índice de exibição mais baixo.

O método DisplayObjectContainer suporta um objeto do tipo clipe de vídeo com um segundo plano de escala 9, que pode ser dimensionado quando o tamanho do objeto TextField é alterado.

Para obter um dimensionamento e desenhos mais complexos, escreva um código para fazer com que o método DisplayObjectContainer ouça um evento captionChange.

Observação Se a propriedade captionTargetName ou captionTarget não for configurada, a ocorrência FLVPlaybackCaptioning cria um campo de texto configurado pela propriedade captionTarget com esta formatação:

• black background (background = true; backgroundColor = 0x000000;)
• white text (textColor = 0xFFFFFF)
• autoSize = TextFieldAutoSize.LEFT
• multiLine = true
• wordWrap = true
• font = "_sans"
• size = 12

Para personalizar esses valores, ouça o evento captionTargetCreated.

Elementos da API relacionados

O nome da ocorrência do objeto TextField ou de MovieClip que delimita um objeto Textfield que contém as legendas.

Para não especificar nenhum destino, configure esta propriedade como uma string vazia (ou seja, nenhum destino especificado) ou auto. Essa propriedade é principalmente usada no inspetor Component. Se você estiver gravando um código, use no lugar a propriedade captionTarget.

O valor padrão é auto.

Elementos da API relacionados

Define a ocorrência de FLVPlayback na qual colocar legendas. A ocorrência FLVPlayback deve ter o mesmo pai que a ocorrência FLVPlaybackCaptioning.

Se a propriedade flvPlaybackName ou flvPlayback não estiver configurada, a ocorrência FLVPlaybackCaptioning pesquisará uma ocorrência FLVPlayback com o mesmo pai e coloca como legenda a primeira que encontrar.

Elementos da API relacionados

Define um nome de ocorrência de FLVPlayback para a ocorrência de FLVPlayback na qual você deseja colocar legendas.

Para não especificar nenhum destino, configure isso como uma string vazia ou auto. A ocorrência FLVPlayback deve ter o mesmo pai que a ocorrência FLVPlaybackCaptioning.

O nome da ocorrência FLVPlayback é principalmente usada no inspetor Component. Se você estiver gravando código, use a propriedade flvPlayback.

Se a propriedade flvPlaybackName ou flvPlayback não estiver configurada ou for configurada como auto, a ocorrência FLVPlaybackCaptioning pesquisa uma ocorrência FLVPlayback com o mesmo pai e coloca como legenda a primeira que encontrar.

O valor padrão é auto.

Elementos da API relacionados

Usado para exibir legendas; true = exibir legendas, false = não exibir legendas.

Se você usar a propriedade captionButton para permitir que o usuário ative e desative as legendas, configure a propriedade showCaptions como false.

O valor padrão é true.

Elementos da API relacionados

Limite as instruções de formatação a partir do arquivo de Texto cronometrado quando definido como true.

Os estilos a seguir não são suportados se a propriedade simpleFormatting for configurada como true:

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

Os estilos a seguir são suportados se a propriedade simpleFormatting for configurada como true:

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

A URL do arquivo de texto cronometrado que contém as informações de legendas (propriedade necessária).

Suporte para faixas de vários idiomas.

A melhor utilização da propriedade track é suportar faixas com vários idiomas com os pontos de sinalização incorporados.

Você deve seguir os formatos suportados para os pontos de sinalização FLVPlaybackCaptioning.

Se a propriedade track for configurada como qualquer outro valor diferente de 0, o componente FLVPlaybackCaptioning pesquisa a propriedade de texto<n> no ponto de sinalização, onde n é o valor de rastreamento.

Por exemplo, se track == 1, então o componente FLVPlayBackCaptioning pesquisa o parâmetro text1 no ponto de sinalização. Caso não se encontre um parâmetro correspondente, é utilizada a propriedade de texto no parâmetro do ponto de sinalização.

O valor padrão é 0.

Conecta a colocação de legendas a um VideoPlayer específico no componente FLVPlayback.

Se desejar usar as legendas em vários players de vídeo (usando as propriedades activeVideoPlayerIndex e visibleVideoPlayerIndex no componente FLVPlayback), você deve criar uma ocorrência do componente FLVPlaybackCaptioning para cada VideoPlayer que você vai usar e definir essa propriedade para corresponder ao índice.

O índice VideoPlayer tem seu padrão em 0 quando é usado apenas o player de vídeo.

Elementos da API relacionados

Cria uma nova ocorrência de FLVPlaybackCaptioning.

Retorna uma matriz dos pontos de sinalização do componente FLVPlayback cujo texto de legenda contém a string de pesquisa.

Parâmetros

Retorna uma matriz dos pontos de sinalização do componente FLVPlayback que contém as legendas.

Retorna uma string que contém todas as legendas como um transcript em formato HTML.

Cada legenda está contida em uma tag p com o atributo de classe "fl_video_caption", um atributo de id exclusivo que começa com a string "fl_video_caption_2_0_" e um atributo de título indicando o código temporal no qual a legenda é exibida no vídeo.

Veja, a seguir, um breve exemplo do HTML retornado:

		 <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

Retorna diversos segundos como uma string de código temporal.

Parâmetros

Despachado quando uma legenda é adicionada ou removida do campo de texto de destino de legenda.

O evento também é despachado quando as seguintes condições forem verdadeiras:

• a propriedade captionTargetName não estiver configurada
• a propriedade captionTarget não estiver configurada
• a ocorrência FLVPlaybackCaptioning criar um objeto TextField automaticamente para colocação de legendas.

O evento captionChange tem a constante CaptionChangeEvent.CAPTION_CHANGE.

Esse evento tem as seguintes propriedades:

Elementos da API relacionados

Despachado depois que se cria a propriedade captionTarget, mas antes que seja adicionada qualquer legenda (a propriedade captionTarget está vazia).

Se a propriedade captionTarget for definida com um DisplayObject personalizado, ou se a propriedade captionTargetName for definida, esse evento não é despachado.

Ouça este evento se você estiver personalizando as propriedades do objeto TextField, por exemplo, a propriedade defaultTextFormat.

O evento captionTargetCreated tem a constante CaptionTargetEvent.CAPTION_TARGET_CREATED.

Esse evento tem as seguintes propriedades:

Elementos da API relacionados

Despachado após o carregamento de todos os dados do arquivo XML de Texto cronometrado.

Esse evento tem as seguintes propriedades:

Elementos da API relacionados

Despachado se uma chamada para o evento URLLoader.load() tentar acessar um arquivo XML de Texto cronometrado via HTTP e o ambiente atual do Flash Player for capaz de detectar e retornar o código de status da solicitação.

Esse evento tem as seguintes propriedades:

Elementos da API relacionados

Despachado se uma chamada para o evento URLLoader.load() resultar em um erro fatal que termine o download do arquivo XML de Texto cronometrado.

Se este evento não for registrado, será lançado um erro.

Esse evento tem as seguintes propriedades:

Elementos da API relacionados

Despachado quando é iniciada a operação de download para carregar o arquivo XML de Texto cronometrado, após uma chamada para o método URLLoader.load().

Esse evento tem as seguintes propriedades:

Elementos da API relacionados

Despachado quando os dados são recebidos conforme o progresso de download do arquivo XML de Texto cronometrado.

Esse evento tem as seguintes propriedades:

Elementos da API relacionados

Despachado se uma chamada para o evento URLLoader.load() tentar carregar um arquivo XML de texto cronometrado a partir de um servidor fora do sandbox de segurança.

Se este evento não for registrado, será lançado um erro.

Esse evento tem as seguintes propriedades:

Elementos da API relacionados

Variável de estado indicando o número curto de versão do componente. O número de versão é útil quando você tem um arquivo FLA e precisa saber a versão do componente. Para determinar a versão do componente, digite o seguinte rastreamento no arquivo FLA:

trace (FLVPlaybackCaptioning.SHORT_VERSION);

A variável SHORT_VERSION inclui apenas o número principal e secundário da versão, por exemplo, 2.0. A variável version inclui o número principal e secundário da versão, bem como os números de revisão e compilação, por exemplo, 2.0.0.xx.

Elementos da API relacionados

Variável de estado indicando o número longo de versão do componente. O número de versão é útil quando você tem um arquivo FLA e precisa saber a versão do componente. Para determinar a versão do componente, digite o seguinte rastreamento no arquivo FLA:

trace (FLVPlaybackCaptioning.VERSION);

A variável VERSION inclui o número principal e secundário da versão, bem como os números de revisão e compilação, por exemplo, 2.0.0.xx. A variável SHORT_VERSION inclui apenas o número principal e secundário da versão, por exemplo, 2.0.

Elementos da API relacionados

Para executar o exemplo, siga estas etapas:

1. Abra um novo arquivo Flash (ActionScript 3.0).
2. Posicione o componente FLVPlayback no Palco em 0,0 e forneça o nome da ocorrência: player.
3. Posicione o componente FLVPlaybackCaptioning no palco em 0,0 e forneça o nome da ocorrência: colocação de legendas.
4. Coloque o componente CaptionButton no Palco.
5. Salve o arquivo FLA e atribua-lhe um nome, por exemplo, captionEx.
6. Abra um novo arquivo ActionScript.
7. Cole o código de exemplo de classe a seguir em um novo arquivo ActionScript e salve-o como FLVPlaybackCaptioningExample.as no mesmo diretório do arquivo FLA.
8. No arquivo FLA (por exemplo, captionEx), no inspetor de propriedades, defina a entrada da classe Document como FLVPlaybackCaptioningExample.
9. Selecione Controlar > Testar filme.

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;            
        }
    }
}