API referenceCore SDK

pdfCreateMovieAction

Create a movie-control action (play/stop/pause/resume).

NoteLumas extension

Purpose — Create a movie-control action (play/stop/pause/resume).

DescriptionLumas extension, not part of the reference ABI: the reference API exposes a movie-action *getter* (pdfGetMovieAction) but no creator, so this engine adds one to give the getter real state to read. Registers action kind 13 with Operation in a and Title (the target movie annotation's title, used to identify which movie to control) in Text.

Declarations

C
int32_t __stdcall pdfCreateMovieAction(PPDF IPDF, const char* Title, int32_t Operation);
Delphi
function pdfCreateMovieAction(const IPDF: PPDF; const Title: PAnsiChar; Operation: Integer): Integer; stdcall; external 'LumasPdf.dll';

Parameters

ParameterTypeDescription
IPDFPPDFInstance handle.
TitlePAnsiCharTitle of the target movie annotation.
OperationInteger0=Play, 1=Stop, 2=Pause, 3=Resume.

Return value — 1-based action handle (> 0), or 0 on an invalid handle.

Remarks — Because this is an engine addition rather than a LumasPDF-ABI function, do not assume a third-party binary exports it by this name; it is specific to LumasPDF.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfCreateMovieAction(IntPtr IPDF, [MarshalAs(UnmanagedType.LPStr)] string Title, int Operation);
Area
Core SDK
Category

Object Creation

Exported names

pdfCreateMovieAction

String variants

The …A form takes UTF-8, …W takes UTF-16; a bare name aliases the ANSI form.

See working code

Worked examples — complete programs in ten languages.