video — u_pbt_video #
← Referência dos componentes · Índice do guia
Leitor de vídeo: um ficheiro do posto — servido em fluxo pela DLL, um filme longo começa de imediato — ou um URL, com a barra de transporte do componente, que segue o tema: reprodução, procura, tempo, silêncio, volume. Legendas WebVTT, cartaz antes da reprodução, ciclo, velocidade, enquadramento, captura da imagem atual em PNG. Tudo o que o utilizador faz na barra, a sua aplicação sabe.
▶ Ver ao vivo — Aplicação de demonstração, mosaico Video player: o filme, o código que o controla e esta página, lado a lado (ligação à Internet necessária para o filme de exemplo).
Em resumo #
| Userobject | u_pbt_video |
| Classe de items | — (componente sem items) |
| Serve para | Um filme de formação na aplicação, o vídeo de um produto, a repetição de uma gravação, um ciclo de apresentação num stand |
| Princípio | Um <video> do motor WebView2: todos os formatos que descodifica (mp4, webm, ogv, m4v). A barra é do componente; os seus gestos passam pelos mesmos verbos que as suas chamadas, logo os mesmos eventos |
| Dependência | O runtime WebView2, já exigido pela biblioteca — nada mais |
Início rápido #
// A film of the workstation, streamed by the DLL : starts at once
uo_video.is_poster = "img\packimages.dll:PNG/COVER" // shown until the film starts
uo_video.is_subtitles = "films\training.vtt"
uo_video.of_play("films\training.mp4")
// A URL plays the same way
uo_video.of_play("https://www.w3schools.com/html/mov_bbb.mp4")
// The user pauses from the bar, or your code does : either way ue_paused fires
uo_video.of_pause()
uo_video.of_seek(90000) // to 1:30, in milliseconds
Tudo o que se define é uma propriedade (is_source, ii_volume, ib_loop…), lida em direto no componente; tudo o que se faz é um método (of_play, of_pause, of_stop, of_seek, of_capture); tudo o que acontece é um evento (ue_started, ue_ended, ue_progress…). Um ficheiro ausente não é uma exceção: ue_failed di-lo, e a mensagem aparece sobre a imagem.
Propriedades #
| Propriedade | Tipo | Predefinição | Função |
|---|---|---|---|
is_source | string | "" | O filme: um ficheiro do posto (qualquer caminho, em fluxo) ou um URL http(s). Defini-lo pára o que tocava; ib_autoplay decide se o novo arranca sozinho. Um filme de qualquer tamanho, também numa aplicação de 32 bits: a DLL serve-o por fatias, nunca o ficheiro inteiro de uma vez; um filme que o motor não consegue descodificar é assinalado por ue_failed |
ib_autoplay | boolean | false | Arranca o filme assim que is_source é definido; senão espera por of_play, pela barra ou pelo teclado, e mostra is_poster |
ib_muted | boolean | false | Corta o som, volume mantido; o botão da barra e a tecla M também o definem |
ii_volume | integer | 100 | Volume em percentagem, 0 a 100; também o cursor da barra e as setas cima/baixo |
ib_loop | boolean | false | Repete o filme em ciclo até of_stop; um filme em ciclo nunca dispara ue_ended |
ii_rate | integer | 100 | Velocidade em percentagem, 25 a 400: 50 = metade, 200 = dobro, o som segue |
is_stretch | string | "uniform" | Enquadramento: STRETCH_NONE, STRETCH_FILL, STRETCH_UNIFORM, STRETCH_UNIFORMTOFILL — os quatro modos de uma imagem |
ib_controls | boolean | true | A barra de transporte do componente, com o tema. false esconde-a: a sua janela controla o filme |
is_poster | string | "" | O cartaz mostrado antes do filme: ficheiro, URL ou pack.dll:NOME, como a origem de uma imagem. Um prefixo mono:/tint:/white:/black: recolore uma imagem monocromática ao tema |
is_subtitles | string | "" | Um ficheiro de legendas, local ou URL: WebVTT (.vtt) ou SubRip (.srt, convertido pela DLL). Uma faixa; of_add_subtitles empilha várias |
is_subtitle_lang | string | "" | A faixa de legendas mostrada (um idioma de of_add_subtitles); vazio = nenhuma |
ii_fps | integer | 25 | Imagens por segundo do filme, para of_step_frames |
ib_remember_position | boolean | false | Lembra onde cada filme foi deixado e retoma aí no próximo of_play da mesma fonte |
is_theme_style | string | fluent | Estilo visual do componente (constantes THEME_STYLE_*) |
is_theme_mode | string | light | Variante clara ou escura (constantes THEME_MODE_*) |
il_theme_accent | long | -1 | Cor de destaque deste componente (-1 = destaque do tema) |
is_tooltip | string | "" | Tooltip simples apresentado ao passar sobre o componente |
is_super_tooltip_title | string | "" | Título do tooltip enriquecido (prevalece sobre is_tooltip) |
is_super_tooltip_text | string | "" | Texto do tooltip enriquecido (aceita marcação enriquecida) |
is_super_tooltip_image | string | "" | Imagem do tooltip enriquecido |
ib_enabled | boolean | true | false: imagem escurecida, barra e teclado inertes; o seu código continua a comandar |
ib_scrub_preview | boolean | true | Uma bolha de tempo segue o cursor sobre a barra (true, por omissão), com o capítulo se houver. false oculta-a |
Um clique na imagem pausa, um segundo retoma. Teclado, quando o filme tem o foco: Espaço ou K reproduzir/pausa, ←/→ cinco segundos, ↑/↓ volume, M silêncio, Início/Fim.
Métodos #
| Método | Função |
|---|---|
of_play ( ) → long | Reproduz is_source de onde está: do início da primeira vez, da pausa depois (ue_resumed). Devolve 0 uma vez enviado, -1 se o componente não está criado |
of_play (string as_source) → long | Define is_source e reproduz: a mesma chamada do leitor de sons. Devolve 0 uma vez enviado, -1 sem componente |
of_pause ( ) → long | Suspende o filme onde está; of_play retoma-o. Devolve 0 uma vez enviado, -1 sem componente |
of_stop ( ) | Pára o filme e volta ao início; segue-se ue_stopped |
of_seek (long al_ms) → long | Posiciona-se num ponto do filme, em milissegundos, em reprodução ou não; um ficheiro local procura de imediato. Devolve 0 uma vez enviado, -1 sem componente |
of_is_playing ( ) → boolean | Verdadeiro enquanto um filme está em curso — pausa incluída, não terminou |
of_is_paused ( ) → boolean | Verdadeiro enquanto o filme está suspenso — por of_pause, pela barra ou pelo teclado |
of_duration ( ) → long | Devolve o número de milissegundos que o filme dura, 0 enquanto desconhecido |
of_position ( ) → long | Devolve o número de milissegundos reproduzidos desde o início; ue_progress também o traz a cada segundo |
of_capture (string as_path) → long | Guarda a imagem mostrada agora em PNG ; espera pela primeira imagem descodificada (10 s no máximo), por isso pode seguir-se diretamente a of_play. Devolve 0 uma vez escrita, -4 sem filme, sem imagem a tempo, ou quando um filme de outro site recusa os seus píxeis, -5 num caminho vazio ou não gravável |
of_fullscreen (boolean ab_on) → long | O filme em TODO o monitor (a DLL move o controlo para uma janela própria; a sua janela não é tocada), ou de volta. Duplo clique, o botão da barra, Escape. Devolve 0, -1 se o componente não estiver criado |
of_is_fullscreen ( ) → boolean | Verdadeiro enquanto o filme cobre o monitor |
of_add_marker (long al_ms, string as_label) → long | Um MARCADOR na barra: um traço clicável, e ue_marker_reached quando o filme o passa. Devolve 0, -5 numa posição negativa, -1 se o componente não estiver criado |
of_clear_markers ( ) → long | Remove todos os marcadores. Devolve 0, -1 se o componente não estiver criado |
of_marker_count ( ) → long | Devolve o número de marcadores |
of_play_range (long al_from_ms, long al_to_ms) → long | Toca UM segmento: no fim, ue_ended, ou com ib_loop o segmento recomeça. Devolve 0, -5 em limites sem sentido, -1 se o componente não estiver criado |
of_clear_range ( ) → long | Liberta o filme do seu segmento. Devolve 0, -1 se o componente não estiver criado |
of_step_frames (long al_frames) → long | Avança ou recua al_frames imagens (ii_fps) e pausa; teclas . e , sobre a imagem. Devolve 0, -1 se o componente não estiver criado |
of_add_source (string as_source) → long | Acrescenta um filme à LISTA DE REPRODUÇÃO: o primeiro torna-se is_source, os seguintes encadeiam-se sozinhos (ue_source_changed). Devolve 0, -5 numa fonte vazia, -1 se o componente não estiver criado |
of_add_source (string as_source, string as_subtitles) → long | Acrescenta um filme COM o seu ficheiro de legendas (.vtt ou .srt, convertido pela DLL): a legenda pertence a esse filme e aparece só quando ele toca. A forma simples e sem ambiguidade de legendar uma lista. Devolve 0, -5 numa fonte vazia |
of_clear_playlist ( ) → long | Esvazia a lista; o filme em curso continua. Devolve 0, -1 se o componente não estiver criado |
of_next ( ) / of_previous ( ) → long | O filme seguinte ou anterior da lista. Devolve 0, -1 se o componente não estiver criado |
of_playlist_count ( ) → long | Devolve o número de filmes da lista |
of_playlist_index ( ) → long | Devolve o índice (a partir de 1) do filme da lista em curso, 0 fora da lista |
of_add_subtitles (string as_lang, string as_source) → long | Uma faixa de legendas por idioma: .vtt, ou .srt convertido pela DLL. O botão CC da barra percorre-as. Devolve 0, -5 numa fonte vazia, -1 se o componente não estiver criado |
of_subtitle_count ( ) → long | Devolve o número de faixas de legendas |
of_remembered_position ( ) → long | Devolve o número de milissegundos onde is_source foi deixado (ib_remember_position), 0 caso contrário |
of_has_output ( ) → boolean | Verdadeiro se o posto tem saída áudio |
of_add_chapter (long al_ms, string as_title) → long | Um CAPÍTULO (índice): ue_chapter_changed quando a leitura entra. of_go_chapter salta (1-based), of_next_chapter / of_previous_chapter percorrem, of_chapter_count / of_chapter_index / of_chapters leem, of_clear_chapters esvazia. Devolve 0, -5 se negativo |
of_clear_chapters ( ) → long | Remove todos os capítulos; a barra e a bolha de pré-visualização esquecem-nos. Devolve 0, -1 se não criado |
of_go_chapter (long al_index) → long | Salta para o capítulo al_index (1-based, pela ordem de of_add_chapter) e lê a partir daí; ue_seeked segue. Devolve 0, -5 para um número inferior a 1 |
of_next_chapter ( ) → long | Salta para o capítulo a seguir à posição atual; ue_seeked segue. Do último capítulo nada se move. Devolve 0, -1 se não criado |
of_previous_chapter ( ) → long | Salta para o capítulo anterior àquele onde está a leitura; ue_seeked segue. Do primeiro capítulo nada se move. Devolve 0, -1 se não criado |
of_chapter_count ( ) → long | Devolve o número de capítulos do filme (of_add_chapter), 0 sem nenhum |
of_chapter_index ( ) → long | Devolve o número (1-based) do capítulo onde está a leitura, 0 antes do primeiro ou sem capítulos. Lido ao vivo |
of_chapters (ref long al_ms[], ref string as_titles[]) → long | Preenche os capítulos por ordem — a posição de cada um em ms em al_ms, o título em as_titles — para construir um menu seu. Devolve o número, 0 sem capítulos |
of_picture_in_picture (boolean ab_on) → long | O filme numa janela flutuante própria (true) ou de volta (false); ue_pip_changed segue. of_is_pip diz se flutua, of_pip_available se o posto permite. Devolve 0, -1 se não criado |
of_is_pip ( ) → boolean | Verdadeiro enquanto o filme flutua na sua janela Picture-in-Picture; falso de novo quando o utilizador a fecha |
of_pip_available ( ) → boolean | Verdadeiro se o motor e o posto permitem o Picture-in-Picture: perguntar antes de oferecer o botão |
Eventos #
| Evento | Quando |
|---|---|
ue_started (long al_duration_ms) | O filme começa realmente; o comprimento quando o ficheiro o diz, 0 caso contrário |
ue_ended (boolean ab_truncated) | O filme terminou por si; ab_truncated verdadeiro quando o limite demo o cortou |
ue_failed (string as_message) | O filme não pôde ser reproduzido: ficheiro ausente, formato não descodificável, URL muda; a mensagem aparece também sobre a imagem |
ue_stopped ( ) | of_stop cortou um filme em curso |
ue_paused ( ) / ue_resumed ( ) | O filme é suspenso, depois retoma — pelo seu código, pela barra ou pelo teclado indistintamente |
ue_progress (long al_position_ms, long al_duration_ms) | Uma vez por segundo durante a reprodução: o que uma barra de progresso sua precisa, sem timer |
ue_seeked (long al_position_ms) | O UTILIZADOR moveu a posição (barra, setas, marcador); nunca of_seek |
ue_volume_changed (long al_percent) | O utilizador rodou o volume; nunca ii_volume |
ue_rate_changed (long al_percent) | O utilizador escolheu uma velocidade na barra; nunca ii_rate |
ue_subtitles_changed (string as_lang) | O utilizador percorreu as legendas (CC); vazio = nenhuma |
ue_fullscreen_changed (boolean ab_on) | O filme passou a ecrã inteiro, ou voltou |
ue_marker_reached (long al_ms, string as_label) | O filme passa um marcador |
ue_source_changed (long al_index, string as_source) | A lista de reprodução passa a outro filme |
ue_chapter_changed (long al_index, string as_title) | A leitura entra noutro capítulo (of_add_chapter): o seu número (1-based, 0 antes do primeiro) e o título |
ue_pip_changed (boolean ab_on) | O filme entra (true) ou sai (false) da janela Picture-in-Picture — por of_picture_in_picture ou pelo utilizador que a fecha |
Ecrã inteiro, marcadores, segmento, imagem a imagem #
- Ecrã inteiro.
of_fullscreen(true), um duplo clique na imagem ou o último botão da barra. A DLL move o controlo para uma janela própria que cobre o monitor; a sua janela PowerBuilder não é tocada, e Escape devolve o filme.ue_fullscreen_changeddi-lo nos dois sentidos. - Marcadores.
of_add_marker(ms, rótulo)põe um traço na barra: o utilizador vê-o, sobrevoa-o (o rótulo), clica-o (o filme salta para lá,ue_seeked), eue_marker_reachedchega quando o filme o passa. Capítulos de uma formação, pontos a controlar, defeitos detetados. - Segmento.
of_play_range(de, a)toca só um excerto; comib_looprepete-o atéof_clear_range. - Imagem a imagem.
of_step_frames(±n)avança ou recua n imagens aii_fpspor segundo e pausa; as teclas . e , fazem o mesmo. O motor não diz a cadência de um filme: diga-a. - A barra fala. O que só o utilizador pode fazer é reportado por um evento próprio:
ue_seeked,ue_volume_changed,ue_rate_changed(o botão de velocidade, 0,5× a 2×),ue_subtitles_changed(o botão CC). O que o seu código faz, ele já sabe:of_seeknão levanta nada.
// Chapters on the bar, then one extract in a loop
uo_video.of_add_marker(2000, "Intro")
uo_video.of_add_marker(5000, "The bunny")
uo_video.ib_loop = true
uo_video.of_play_range(2000, 8000)
// Surveillance : back one picture at a time
uo_video.ii_fps = 30
uo_video.of_step_frames(-1)
Lista de reprodução, legendas, retoma, formatos #
- Lista de reprodução.
of_add_sourceempilha filmes; o primeiro torna-seis_source, os seguintes encadeiam-se sozinhos no fim de cada um,ue_source_changednomeia cada passagem.of_nexteof_previousà mão. - Várias faixas de legendas.
of_add_subtitles(idioma, ficheiro)por idioma;is_subtitle_langescolhe, o botão CC da barra percorre. Um.srté convertido em WebVTT pela DLL ao servi-lo: nada a converter do seu lado. - Retoma.
ib_remember_position = true: onde um filme é deixado (pausa, paragem) é guardado pelo motor neste posto, por utilizador, e o próximoof_playda mesma fonte retoma aí. Um filme visto até ao fim recomeça do início. - Formatos. O que o WebView2 descodifica: mp4 (H.264, AAC), webm (VP8, VP9, AV1), ogv (Theora), e os formatos áudio (mp3, wav, ogg, flac, aac, m4a). Sem H.265/HEVC sem a extensão do Windows, nem AVI, WMV, MKV, MOV antigos: o componente recusa-os pelo nome (
ue_failednomeia a extensão) em vez de um ecrã preto. Nem HLS nem DASH: uma câmara IP passa por um fluxo mp4 ou webm. - Várias faixas áudio. O Chromium esconde-as atrás de uma flag: não expostas.
// A playlist with two subtitle tracks, the position remembered
uo_video.ib_remember_position = true
uo_video.of_add_subtitles("en", "film.en.vtt")
uo_video.of_add_subtitles("fr", "film.fr.srt") // .srt : converted by the DLL
uo_video.is_subtitle_lang = "fr"
uo_video.of_add_source("intro.mp4")
uo_video.of_add_source("lesson-1.mp4")
uo_video.of_play()
Exemplos #
Um ciclo de apresentação silencioso, sem barra #
uo_video.ib_controls = false
uo_video.ib_muted = true
uo_video.ib_loop = true
uo_video.is_stretch = u_pbt_video.STRETCH_UNIFORMTOFILL
uo_video.of_play("films\showcase.mp4")
Os seus botões e uma barra de progresso #
// cb_play.clicked
if uo_video.of_is_paused() or not uo_video.of_is_playing() then uo_video.of_play() else uo_video.of_pause()
// uo_video.ue_progress : once a second, no timer needed
hpb_progress.Position = al_position_ms * 100 / Max(al_duration_ms, 1)
Uma miniatura do filme para um relatório #
uo_video.of_play("films\training.mp4")
uo_video.of_pause()
uo_video.of_seek(15000) // the frame at 0:15
// of_capture waits for the picture itself (10 s at most) : no timer to write
if uo_video.of_capture("report\training.png") <> 0 then MessageBox("Capture", uo_video.of_get_last_error())
Boas práticas #
- Um ficheiro do posto em vez de um URL sempre que puder: servido em fluxo pela DLL, arranca de imediato, procura sem recarregar, e
of_capturepode ler os seus píxeis — o que um filme de outro site recusa. - Programe
ue_failedem qualquer filme cujo caminho dependa dos dados: é a sua única rede, e a mensagem já está no ecrã. - Defina
ib_autoplaysó para um ciclo de apresentação: um filme que arranca sozinho com som surpreende o utilizador; noutros casos bastam o cartaz e o botão de reprodução. ue_progresssubstitui um timer: uma vez por segundo, posição e comprimento, só durante a reprodução.
Herdado da base comum #
Estes membros existem em todos os componentes visuais — não são próprios deste. São detalhados uma só vez, nos capítulos transversais; esta tabela apenas diz onde os ler.
| Membros | Função | Detalhado em |
|---|---|---|
of_reset | Repor o componente a zero | 3.6 Repor um componente a zero: of_reset() |
of_register_shortcut · of_clear_shortcuts | Atalhos de teclado do componente | 3.5 Os atalhos de teclado |
of_is_created · of_is_ready · of_get_last_error | Se nasceu, se está pronto, o que falhou | 3.7 Diagnóstico |
of_save_as_png · of_save_as_jpg | Exportar a renderização como imagem | 3.8 Exportar a representação como imagem |
of_set_redraw | Agrupar as alterações num único repinte | 3.10 Boas práticas |
of_preload_icons | Ícones mostrados sem atraso | Apresentação instantânea: of_icon |
of_set_translation | Traduzir uma legenda do componente | 5.2 Adaptar uma etiqueta: of_set_translation |
of_focus_webview | Dar o foco ao componente | 6.4 Teclado e focus |
of_print · of_print_to_pdf | Imprimir, ou escrever um PDF | 6.9 Imprimir |
of_set_property · of_get_property · of_component_name | Controlar uma propriedade pelo nome | 3.1 O motor de propriedades |