SoundAction
extends Action
in package
Sound action (/S /Sound) — ISO 32000-2 §12.6.4.8.
Plays a sound stream.
Attributes
- #[DeprecatedPdfFeature]
- $since: '2.0'
- $replacement: 'RenditionAction'
- $removedIn: '2.0'
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_5
Table of Contents
Constants
- PDF_TYPE = 'Action'
Properties
- $generationNumber : int
- $mix : bool|null
- $next : PdfReference|null
- $objectNumber : int
- $repeat : bool|null
- $sound : PdfReference
- $synchronous : bool|null
- $volume : float|null
Methods
- __construct() : mixed
- getActionType() : string
- Returns the /S (action type) value for this action.
- toIndirectObject() : string
- Wrap the object in an indirect object structure: X Y obj ... endobj
- toPdf() : string
- Serialize the object's dictionary/value to PDF syntax.
- baseDictionary() : PdfDictionary
- Build a dictionary pre-populated with the common /Type, /S, and /Next entries so subclasses only need to add their subtype-specific fields.
Constants
PDF_TYPE
public
mixed
PDF_TYPE
= 'Action'
Properties
$generationNumber
public
int
$generationNumber
= 0
$mix
public
bool|null
$mix
= null
$next
public
PdfReference|null
$next
= null
$objectNumber
public
int
$objectNumber
= 0
$repeat
public
bool|null
$repeat
= null
$sound
public
PdfReference
$sound
$synchronous
public
bool|null
$synchronous
= null
$volume
public
float|null
$volume
= null
Methods
__construct()
public
__construct(PdfReference $sound) : mixed
Parameters
- $sound : PdfReference
getActionType()
Returns the /S (action type) value for this action.
public
getActionType() : string
Return values
stringtoIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Serialize the object's dictionary/value to PDF syntax.
public
toPdf() : string
Return values
stringbaseDictionary()
Build a dictionary pre-populated with the common /Type, /S, and /Next entries so subclasses only need to add their subtype-specific fields.
protected
baseDictionary() : PdfDictionary