Skip to content

Smil

Classes for ODF implementation of SMIL (Synchronized Multimedia Integration Language).

Classes:

Name Description
AnimPar

Container for SMIL animations, “anim:par”.
AnimSeq

Container for SMIL Presentation Animations, “anim:seq”.
AnimTransFilter

Transition between two frames, “anim:transitionFilter”.

AnimPar

Bases: Element

Container for SMIL animations, “anim:par”.

Methods:

Name Description
__init__

Create a container for SMIL presentation animations “anim:par”.

Attributes:

Name Type Description
presentation_node_type
smil_begin
Source code in odfdo/smil.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
class AnimPar(Element):
    """Container for SMIL animations, "anim:par"."""

    _tag = "anim:par"
    _properties = (
        PropDef("presentation_node_type", "presentation:node-type"),
        PropDef("smil_begin", "smil:begin"),
    )

    def __init__(
        self,
        presentation_node_type: str | None = None,
        smil_begin: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a container for SMIL presentation animations "anim:par".

        Args:
            presentation_node_type: The type of presentation node.
                Can be 'default', 'on-click', 'with-previous', 'after-previous',
                'timing-root', 'main-sequence', or 'interactive-sequence'.
            smil_begin: Specifies the begin time of the animation.
                Can be 'indefinite', a time value (e.g., '10s'), or an ID reference
                (e.g., '[id].click', '[id].begin').
        """
        super().__init__(**kwargs)
        if self._do_init:
            if presentation_node_type:
                self.presentation_node_type = presentation_node_type
            if smil_begin:
                self.smil_begin = smil_begin

_properties class-attribute instance-attribute 

_properties = (
    PropDef(
        "presentation_node_type", "presentation:node-type"
    ),
    PropDef("smil_begin", "smil:begin"),
)

_tag class-attribute instance-attribute 

_tag = 'anim:par'

presentation_node_type instance-attribute 

presentation_node_type = presentation_node_type

smil_begin instance-attribute 

smil_begin = smil_begin

__init__ 

__init__(
    presentation_node_type: str | None = None,
    smil_begin: str | None = None,
    **kwargs: Any,
) -> None

Create a container for SMIL presentation animations “anim:par”.

Parameters:

Name Type Description Default
presentation_node_type str | None

The type of presentation node. Can be ‘default’, ‘on-click’, ‘with-previous’, ‘after-previous’, ‘timing-root’, ‘main-sequence’, or ‘interactive-sequence’.

 None
smil_begin str | None

Specifies the begin time of the animation. Can be ‘indefinite’, a time value (e.g., ’10s’), or an ID reference (e.g., ‘[id].click’, ‘[id].begin’).

 None
Source code in odfdo/smil.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def __init__(
    self,
    presentation_node_type: str | None = None,
    smil_begin: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a container for SMIL presentation animations "anim:par".

    Args:
        presentation_node_type: The type of presentation node.
            Can be 'default', 'on-click', 'with-previous', 'after-previous',
            'timing-root', 'main-sequence', or 'interactive-sequence'.
        smil_begin: Specifies the begin time of the animation.
            Can be 'indefinite', a time value (e.g., '10s'), or an ID reference
            (e.g., '[id].click', '[id].begin').
    """
    super().__init__(**kwargs)
    if self._do_init:
        if presentation_node_type:
            self.presentation_node_type = presentation_node_type
        if smil_begin:
            self.smil_begin = smil_begin

AnimSeq

Bases: Element

Container for SMIL Presentation Animations, “anim:seq”.

Animations inside this block are executed after the slide has executed its initial transition.

Methods:

Name Description
__init__

Create a container for SMIL Presentation Animations “anim:seq”.

Attributes:

Name Type Description
presentation_node_type
Source code in odfdo/smil.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
class AnimSeq(Element):
    """Container for SMIL Presentation Animations, "anim:seq".

    Animations inside this block are executed after the slide has executed its
    initial transition.
    """

    _tag = "anim:seq"
    _properties = (PropDef("presentation_node_type", "presentation:node-type"),)

    def __init__(
        self,
        presentation_node_type: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a container for SMIL Presentation Animations "anim:seq".

        Animations inside this block are executed after the slide
        has executed its initial transition.

        Args:
            presentation_node_type: The type of presentation node.
                Can be 'default', 'on-click', 'with-previous', 'after-previous',
                'timing-root', 'main-sequence', or 'interactive-sequence'.
        """
        super().__init__(**kwargs)
        if self._do_init and presentation_node_type:
            self.presentation_node_type = presentation_node_type

_properties class-attribute instance-attribute 

_properties = (
    PropDef(
        "presentation_node_type", "presentation:node-type"
    ),
)

_tag class-attribute instance-attribute 

_tag = 'anim:seq'

presentation_node_type instance-attribute 

presentation_node_type = presentation_node_type

__init__ 

__init__(
    presentation_node_type: str | None = None, **kwargs: Any
) -> None

Create a container for SMIL Presentation Animations “anim:seq”.

Animations inside this block are executed after the slide has executed its initial transition.

Parameters:

Name Type Description Default
presentation_node_type str | None

The type of presentation node. Can be ‘default’, ‘on-click’, ‘with-previous’, ‘after-previous’, ‘timing-root’, ‘main-sequence’, or ‘interactive-sequence’.

 None
Source code in odfdo/smil.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def __init__(
    self,
    presentation_node_type: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a container for SMIL Presentation Animations "anim:seq".

    Animations inside this block are executed after the slide
    has executed its initial transition.

    Args:
        presentation_node_type: The type of presentation node.
            Can be 'default', 'on-click', 'with-previous', 'after-previous',
            'timing-root', 'main-sequence', or 'interactive-sequence'.
    """
    super().__init__(**kwargs)
    if self._do_init and presentation_node_type:
        self.presentation_node_type = presentation_node_type

AnimTransFilter

Bases: Element

Transition between two frames, “anim:transitionFilter”.

Methods:

Name Description
__init__

Create a transition between two frames “anim:transitionFilter”.

Attributes:

Name Type Description
smil_direction
smil_dur
smil_fadeColor
smil_mode
smil_subtype
smil_type
Source code in odfdo/smil.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
class AnimTransFilter(Element):
    """Transition between two frames, "anim:transitionFilter"."""

    _tag = "anim:transitionFilter"
    _properties = (
        PropDef("smil_dur", "smil:dur"),
        PropDef("smil_type", "smil:type"),
        PropDef("smil_subtype", "smil:subtype"),
        PropDef("smil_direction", "smil:direction"),
        PropDef("smil_fadeColor", "smil:fadeColor"),
        PropDef("smil_mode", "smil:mode"),
    )

    def __init__(
        self,
        smil_dur: str | None = None,
        smil_type: str | None = None,
        smil_subtype: str | None = None,
        smil_direction: str | None = None,
        smil_fadeColor: str | None = None,
        smil_mode: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a transition between two frames "anim:transitionFilter".

        Args:
            smil_dur: The duration of the transition.
            smil_type: The type of transition. See
                http://www.w3.org/TR/SMIL20/smil-transitions.html#TransitionEffects-Appendix
                for a list of types.
            smil_subtype: The subtype of transition. See
                http://www.w3.org/TR/SMIL20/smil-transitions.html#TransitionEffects-Appendix
                for a list of subtypes.
            smil_direction: The direction of the transition. Can be
                'forward' or 'reverse'.
            smil_fadeColor: The fade color for the transition.
            smil_mode: The mode of the transition. Can be 'in' or 'out'.
        """
        super().__init__(**kwargs)
        if self._do_init:
            if smil_dur:
                self.smil_dur = smil_dur
            if smil_type:
                self.smil_type = smil_type
            if smil_subtype:
                self.smil_subtype = smil_subtype
            if smil_direction:
                self.smil_direction = smil_direction
            if smil_fadeColor:
                self.smil_fadeColor = smil_fadeColor
            if smil_mode:
                self.smil_mode = smil_mode

_properties class-attribute instance-attribute 

_properties = (
    PropDef("smil_dur", "smil:dur"),
    PropDef("smil_type", "smil:type"),
    PropDef("smil_subtype", "smil:subtype"),
    PropDef("smil_direction", "smil:direction"),
    PropDef("smil_fadeColor", "smil:fadeColor"),
    PropDef("smil_mode", "smil:mode"),
)

_tag class-attribute instance-attribute 

_tag = 'anim:transitionFilter'

smil_direction instance-attribute 

smil_direction = smil_direction

smil_dur instance-attribute 

smil_dur = smil_dur

smil_fadeColor instance-attribute 

smil_fadeColor = smil_fadeColor

smil_mode instance-attribute 

smil_mode = smil_mode

smil_subtype instance-attribute 

smil_subtype = smil_subtype

smil_type instance-attribute 

smil_type = smil_type

__init__ 

__init__(
    smil_dur: str | None = None,
    smil_type: str | None = None,
    smil_subtype: str | None = None,
    smil_direction: str | None = None,
    smil_fadeColor: str | None = None,
    smil_mode: str | None = None,
    **kwargs: Any,
) -> None

Create a transition between two frames “anim:transitionFilter”.

Parameters:

Name Type Description Default
smil_dur str | None

The duration of the transition.

 None
smil_type str | None

The type of transition. See http://www.w3.org/TR/SMIL20/smil-transitions.html#TransitionEffects-Appendix for a list of types.

 None
smil_subtype str | None

The subtype of transition. See http://www.w3.org/TR/SMIL20/smil-transitions.html#TransitionEffects-Appendix for a list of subtypes.

 None
smil_direction str | None

The direction of the transition. Can be ‘forward’ or ‘reverse’.

 None
smil_fadeColor str | None

The fade color for the transition.

 None
smil_mode str | None

The mode of the transition. Can be ‘in’ or ‘out’.

 None
Source code in odfdo/smil.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
def __init__(
    self,
    smil_dur: str | None = None,
    smil_type: str | None = None,
    smil_subtype: str | None = None,
    smil_direction: str | None = None,
    smil_fadeColor: str | None = None,
    smil_mode: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a transition between two frames "anim:transitionFilter".

    Args:
        smil_dur: The duration of the transition.
        smil_type: The type of transition. See
            http://www.w3.org/TR/SMIL20/smil-transitions.html#TransitionEffects-Appendix
            for a list of types.
        smil_subtype: The subtype of transition. See
            http://www.w3.org/TR/SMIL20/smil-transitions.html#TransitionEffects-Appendix
            for a list of subtypes.
        smil_direction: The direction of the transition. Can be
            'forward' or 'reverse'.
        smil_fadeColor: The fade color for the transition.
        smil_mode: The mode of the transition. Can be 'in' or 'out'.
    """
    super().__init__(**kwargs)
    if self._do_init:
        if smil_dur:
            self.smil_dur = smil_dur
        if smil_type:
            self.smil_type = smil_type
        if smil_subtype:
            self.smil_subtype = smil_subtype
        if smil_direction:
            self.smil_direction = smil_direction
        if smil_fadeColor:
            self.smil_fadeColor = smil_fadeColor
        if smil_mode:
            self.smil_mode = smil_mode