PBToolboxAI v4 ← Site

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 ou JPEG. 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 #

Userobjectu_pbt_video
Classe de items— (componente sem items)
Serve paraUm 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ípioUm <video> do motor WebView2: todos os formatos que descodifica (mp4, webm, m4v, mov, mkv). A barra é do componente; os seus gestos passam pelos mesmos verbos que as suas chamadas, logo os mesmos eventos
DependênciaO 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(/*source*/ "films\training.mp4")

// A URL plays the same way
uo_video.of_play(/*source*/ "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(/*ms*/ 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 #

PropriedadeTipoPredefiniçãoFunção
is_sourcestring""O filme: um ficheiro do posto (qualquer caminho, em fluxo) ou um URL https. Um endereço http:// é recusado (ue_failed, REASON_INSECURE): o motor promove-o a https e falha — descarregue primeiro o filme (restclient, of_download). Formatos: mp4, webm, m4v, mov (um filme de iPhone ou de câmara em H.264), mkv e os formatos áudio; avi, wmv e flv são recusados pelo nome (REASON_FORMAT). 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. Um NOVO filme deixa para trás o que pertencia ao anterior: o seu segmento, legendas, marcadores e capítulos (definidos antes de qualquer filme, esperam pelo primeiro); um filme da lista conserva as suas próprias legendas
ib_autoplaybooleanfalseArranca o filme assim que is_source é definido; senão espera por of_play, pela barra ou pelo teclado, e mostra is_poster
ib_mutedbooleanfalseCorta o som, volume mantido; o botão da barra e a tecla M também o definem
ii_volumeinteger100Volume em percentagem, 0 a 100; também o cursor da barra e as setas cima/baixo
ib_loopbooleanfalseRepete o filme em ciclo até of_stop; um filme em ciclo nunca dispara ue_ended
ii_rateinteger100Velocidade em percentagem, 25 a 400: 50 = metade, 200 = dobro, o som segue
is_stretchstring"uniform"Enquadramento: STRETCH_NONE, STRETCH_FILL, STRETCH_UNIFORM, STRETCH_UNIFORMTOFILL — os quatro modos de uma imagem
ib_controlsbooleantrueA barra de transporte do componente, com o tema. false esconde-a: a sua janela controla o filme
is_posterstring""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_subtitlesstring""Um ficheiro de legendas, local ou URL https: WebVTT (.vtt) ou SubRip (.srt, convertido — UTF-8, UTF-16 ou a página de código ANSI do posto). Um URL é DESCARREGADO pelo componente: o seu servidor tem de autorizar CORS (GitHub, um CDN fazem-no); uma recusa, ou um URL http://, é dita por ue_subtitles_failed e o filme continua. Uma faixa; of_add_subtitles empilha várias. Pertence ao filme: um novo is_source retira-a
is_subtitle_langstring""A faixa de legendas mostrada (um idioma de of_add_subtitles); vazio = nenhuma
ii_fpsinteger25Imagens por segundo do filme, para of_step_frames
ib_remember_positionbooleanfalseLembra onde cada filme foi deixado e retoma aí no próximo of_play da mesma fonte
is_theme_stylestring""Estilo visual do componente (constantes THEME_STYLE_*); vazio = o da aplicação, seguido a cada mudança
is_theme_modestring""Variante clara ou escura (constantes THEME_MODE_*); vazio = a da aplicação, seguida a cada mudança
il_theme_accentlong-1Cor de destaque deste componente (-1 = destaque da aplicação, ou o do tema)
is_tooltipstring""Tooltip simples apresentado ao passar sobre o componente
is_super_tooltip_titlestring""Título do tooltip enriquecido (prevalece sobre is_tooltip)
is_super_tooltip_textstring""Texto do tooltip enriquecido (aceita marcação enriquecida)
is_super_tooltip_imagestring""Imagem do tooltip enriquecido
ib_enabledbooleantruefalse: imagem escurecida, barra e teclado inertes — exceto Escape em ecrã inteiro: pode-se sempre sair; o seu código continua a comandar
ib_scrub_previewbooleantrueUma bolha de tempo segue o cursor sobre a barra (true, por omissão), com o capítulo se houver. false oculta-a
ib_pause_when_hiddenbooleantruePõe o filme em pausa quando o componente fica OCULTO (outra página de um tab ou de um dock PBToolboxAI, PBT_SetVisible): ue_paused segue, e o filme espera por of_play, nunca retoma sozinho. false deixa-o tocar (uma parede de ecrãs). Um Tab NATIVO do PowerBuilder não avisa o componente: chame of_pause no seu SelectionChanged

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étodoFunção
of_play ( ) → longReproduz is_source de onde está: do início da primeira vez, da pausa depois (ue_resumed). Devolve 0 uma vez enviado, -2 se o componente não está criado
of_play (string as_source) → longDefine is_source e reproduz: a mesma chamada do leitor de sons. Devolve 0 uma vez enviado, -1 sem componente
of_pause ( ) → longSuspende 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) → longPosiciona-se num ponto do filme, em milissegundos, em reprodução ou não; um ficheiro local procura de imediato. ue_seeked segue-se, como com a barra. Devolve 0 uma vez enviado, -2 se o componente não estiver criado
of_is_playing ( ) → booleanVerdadeiro enquanto um filme está em curso — pausa incluída, não terminou
of_is_paused ( ) → booleanVerdadeiro enquanto o filme está suspenso — por of_pause, pela barra ou pelo teclado
of_is_buffering ( ) → booleanVerdadeiro enquanto o filme CORRE mas espera pelos seus dados — o tempo que ue_buffering anunciou. Lido no componente, nunca numa cópia
of_duration ( ) → longDevolve o número de milissegundos que o filme dura, 0 enquanto desconhecido
of_position ( ) → longDevolve o número de milissegundos reproduzidos desde o início; ue_progress também o traz a cada segundo
of_capture (string as_path) → longGuarda a imagem mostrada agora, no tamanho do filme: of_capture(as_path, 0). A EXTENSÃO escolhe o formato: .jpg ou .jpeg escreve um JPEG, todo o resto um 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, com um filme que não se conseguiu carregar, sem imagem a tempo, quando um filme de outro site recusa os seus píxeis ou quando o ficheiro não pode ser escrito, -5 num caminho vazio ou que depende da pasta atual (\x, C:x), -2 se o componente não estiver criado; após um retorno negativo, of_get_last_error diz porquê. Um caminho relativo é escrito na pasta em que a aplicação arrancou (a pasta atual ao carregar a biblioteca, a mesma no IDE e compilada)
of_capture (string as_path, long al_max_width) → longA mesma captura, REDUZIDA a al_max_width píxeis de largura (altura em proporção): a miniatura de um filme 4K não é uma imagem 4K. 0 mantém o tamanho do filme. Mesmos retornos que of_capture(as_path)
of_fullscreen (boolean ab_on) → longO filme em TODO o monitor (a DLL move o controlo para uma janela própria; a sua janela não é tocada), ou de volta. Acima de tudo enquanto é a janela ativa: Alt+Tab para outra aplicação põe essa aplicação à frente, e voltar à sua põe de novo o filme acima de tudo. Duplo clique, o botão da barra, Escape, Alt+F4. Escape sai mesmo quando ib_enabled é falso. Estes gestos e esta chamada lançam ue_fullscreen_changed (of_is_fullscreen lê-o). Devolve 0, -2 se o componente não estiver criado
of_is_fullscreen ( ) → booleanVerdadeiro enquanto o filme cobre o monitor
of_add_marker (long al_ms, string as_label) → longUm MARCADOR na barra: um traço clicável, e ue_marker_reached quando o filme o passa. Devolve 0, -5 numa posição negativa, -2 se o componente não estiver criado
of_clear_markers ( ) → longRemove todos os marcadores. Devolve 0, -2 se o componente não estiver criado
of_marker_count ( ) → longDevolve o número de marcadores
of_play_range (long al_from_ms, long al_to_ms) → longToca UM segmento: no fim, ue_ended, ou com ib_loop o segmento recomeça. Devolve 0, -5 em limites sem sentido, -2 se o componente não estiver criado
of_clear_range ( ) → longLiberta o filme do seu segmento. Devolve 0, -2 se o componente não estiver criado
of_step_frames (long al_frames) → longAvança ou recua al_frames imagens (ii_fps) e pausa; teclas . e , sobre a imagem. ue_seeked segue-se, como com as teclas. Devolve 0, -2 se o componente não estiver criado
of_add_source (string as_source) → longAcrescenta um filme à LISTA DE REPRODUÇÃO: o primeiro torna-se is_source (por cima de um filme definido antes, exceto se estiver A TOCAR: a lista segue-o então no fim), os seguintes encadeiam-se sozinhos (ue_source_changed para cada filme que se segue, e para o primeiro quando esta chamada o carrega). Devolve 0, -5 numa fonte vazia, -2 se o componente não estiver criado
of_add_source (string as_source, string as_subtitles) → longAcrescenta 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 ( ) → longEsvazia a lista; o filme em curso continua. Devolve 0, -2 se o componente não estiver criado
of_next ( ) / of_previous ( ) → longO filme seguinte ou anterior da lista; of_playlist_index diz onde está, e ue_source_changed segue-se. Devolve 0, -2 se o componente não estiver criado
of_playlist_count ( ) → longDevolve o número de filmes da lista
of_playlist_index ( ) → longDevolve 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) → longUma faixa de legendas por idioma: .vtt, ou .srt convertido, do posto ou de um URL https (descarregado: CORS necessário, ver ue_subtitles_failed). O botão CC da barra percorre-as. Devolve 0, -5 numa fonte vazia, um idioma já definido no filme (of_remove_subtitles primeiro) ou que contém / ou `, -2` se o componente não estiver criado
of_remove_subtitles (string as_lang) → longRetira a faixa de um idioma do filme no ecrã (e do filme da lista que toca: não volta com of_previous). A faixa de is_subtitles chama-se default. Devolve 0, -5 para um idioma que o filme não tem, -2 se o componente não estiver criado
of_subtitle_count ( ) → longDevolve o número de faixas de legendas
of_remembered_position ( ) → longDevolve o número de milissegundos onde is_source foi deixado (ib_remember_position), 0 caso contrário
of_has_output ( ) → booleanVerdadeiro se o posto tem saída áudio
of_add_chapter (long al_ms, string as_title) → longUm CAPÍTULO (índice): ue_chapter_changed quando a leitura entra. of_go_chapter salta (1-based), of_next_chapter / of_previous_chapter percorrem (cada salto lança ue_seeked e ue_chapter_changed), of_chapter_count / of_chapter_index / of_chapters leem, of_clear_chapters esvazia. Devolve 0, -5 se negativo
of_clear_chapters ( ) → longRemove todos os capítulos; a barra e a bolha de pré-visualização esquecem-nos. Devolve 0, -2 se não criado
of_go_chapter (long al_index) → longSalta para o capítulo al_index (1-based, pela ordem de of_add_chapter); of_chapter_index lê-o de imediato, e ue_seeked e depois ue_chapter_changed seguem-se, como com um clique na barra. Devolve 0, -5 para um número inferior a 1 ou superior a of_chapter_count(), -2 se o componente não estiver criado
of_next_chapter ( ) → longSalta para o capítulo a seguir à posição atual; of_chapter_index lê-o de imediato, e ue_seeked e depois ue_chapter_changed seguem-se. Do último capítulo nada se move. Devolve 0, -2 se não criado
of_previous_chapter ( ) → longSalta para o capítulo anterior àquele onde está a leitura; of_chapter_index lê-o de imediato, e ue_seeked e depois ue_chapter_changed seguem-se. Do primeiro capítulo nada se move. Devolve 0, -2 se não criado
of_chapter_count ( ) → longDevolve o número de capítulos do filme (of_add_chapter), 0 sem nenhum
of_chapter_index ( ) → longDevolve 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[]) → longPreenche 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; um título pode conter qualquer carácter. Devolve o número, 0 sem capítulos
of_picture_in_picture (boolean ab_on) → longO filme numa janela flutuante própria (true) ou de volta (false); ue_pip_changed segue-se, como quando o utilizador fecha a janela pequena. of_is_pip diz se flutua, of_pip_available se o posto permite. Devolve 0, -2 se não criado
of_is_pip ( ) → booleanVerdadeiro enquanto o filme flutua na sua janela Picture-in-Picture; falso de novo quando o utilizador a fecha
of_pip_available ( ) → booleanVerdadeiro se o motor e o posto permitem o Picture-in-Picture: perguntar antes de oferecer o botão

Eventos #

EventoQuando
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, string as_reason)O filme não pôde ser reproduzido. as_reason di-lo numa palavra que o seu código testa: REASON_INSECURE (uma fonte http://), REASON_FORMAT (avi, wmv, flv, ou um formato que o motor declara ilegível), REASON_UNSUPPORTED (ficheiro ausente ou contentor não descodificável), REASON_DECODE, REASON_NETWORK, REASON_NO_SOURCE, REASON_FAILED; as_message é o texto mostrado 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; também quando o componente fica oculto (ib_pause_when_hidden)
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)A posição mudou: o utilizador (barra, setas, marcador) ou o seu código — of_seek, of_step_frames e as funções de capítulo também o lançam, como o gesto
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_muted_changed (boolean ab_on)O utilizador cortou (true) ou repôs (false) o som — o altifalante da barra, a tecla M; nunca ib_muted
ue_fullscreen_changed (boolean ab_on)O filme passou a ecrã inteiro, ou voltou: duplo clique, o botão, Escape, Alt+F4, ou of_fullscreen. of_reset nunca o lança
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: sozinha, tendo o anterior terminado, ou por of_next, of_previous e o primeiro of_add_source
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; também quando o utilizador ou o seu código (of_go_chapter, of_next_chapter, of_previous_chapter) salta para lá
ue_pip_changed (boolean ab_on)O filme entrou (true) na janela Picture-in-Picture ou saiu dela (false): o utilizador fechou-a, o motor pôs lá o filme por si, ou of_picture_in_picture pediu-o (of_is_pip lê-o)
ue_subtitles_failed (string as_lang, string as_reason)Um ficheiro de legendas não pôde ser carregado: um URL https cujo servidor recusa CORS ou responde um erro (REASON_NETWORK, REASON_NOT_FOUND), um URL http:// (REASON_INSECURE). A faixa é retirada, o filme continua
ue_buffering (boolean ab_on)O filme CORRE mas tem de esperar pelos seus dados mais de um quarto de segundo (true) — uma rede lenta, um salto para longe num filme de um URL: um anel na cor de destaque do tema roda sobre a imagem — depois a espera acaba (false): o filme retoma, ou foi pausado, parado, substituído, ou falhou. of_reset nunca o lança

Ecrã inteiro, marcadores, segmento, imagem a imagem #

// Chapters on the bar, then one extract in a loop
uo_video.of_add_marker(/*ms*/ 2000, /*label*/ "Intro")
uo_video.of_add_marker(/*ms*/ 5000, /*label*/ "The bunny")
uo_video.ib_loop = true
uo_video.of_play_range(/*from_ms*/ 2000, /*to_ms*/ 8000)

// Surveillance : back one picture at a time
uo_video.ii_fps = 30
uo_video.of_step_frames(/*frames*/ -1)

Lista de reprodução, legendas, retoma, formatos #

// A playlist, each film WITH its subtitles, the position remembered
uo_video.ib_remember_position = true
uo_video.of_add_source(/*source*/ "intro.mp4", /*subtitles*/ "intro.en.vtt")
uo_video.of_add_source(/*source*/ "lesson-1.mp4", /*subtitles*/ "lesson-1.en.srt")   // .srt : converted by the DLL
uo_video.of_play()

// A second language for the film on screen : it stays with that film
uo_video.of_add_subtitles(/*lang*/ "fr", /*source*/ "intro.fr.vtt")
uo_video.is_subtitle_lang = "fr"

Exemplos #

Um ciclo de apresentação silencioso, sem barra #

// A silent showcase film, in a loop, without its bar
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(/*source*/ "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 #

// Stop the film on the picture to keep
uo_video.of_play(/*source*/ "films\training.mp4")
uo_video.of_pause()
uo_video.of_seek(/*ms*/ 15000)                 // the frame at 0:15

// of_capture waits for the picture itself (10 s at most) : no timer to write.
// A .jpg path writes a JPEG ; 320 : a thumbnail 320 pixels wide.
// A relative path goes to the folder the application started in.
if uo_video.of_capture(/*path*/ "C:\Reports\training.jpg", /*max_width*/ 320) < 0 then MessageBox("Capture", uo_video.of_get_last_error())

Boas práticas #

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.

MembrosFunçãoDetalhado em
of_resetRepor o componente a zero3.6 Repor um componente a zero: of_reset()
of_register_shortcut · of_clear_shortcutsAtalhos de teclado do componente3.5 Os atalhos de teclado
of_is_created · of_is_ready · of_get_last_errorSe nasceu, se está pronto, o que falhou3.7 Diagnóstico
of_save_as_png · of_save_as_jpgExportar a renderização como imagem3.8 Exportar a representação como imagem
of_set_redrawAgrupar as alterações num único repinte3.10 Boas práticas
of_preload_iconsÍcones mostrados sem atrasoApresentação instantânea: of_icon
of_set_translationTraduzir uma legenda do componente5.2 Adaptar uma etiqueta: of_set_translation
of_focus_webviewDar o foco ao componente6.4 Teclado e focus
of_print · of_print_to_pdfImprimir, ou escrever um PDF6.9 Imprimir
of_set_property · of_get_property · of_component_nameControlar uma propriedade pelo nome3.1 O motor de propriedades

← Referência dos componentes · Índice do guia