1
1
# Pyrlottie
2
2
3
- [ Pyrlottie Index] ( ../README.md#pyrlottie-index ) /
4
- Pyrlottie
3
+ [ Pyrlottie Index] ( ../README.md#pyrlottie-index ) / Pyrlottie
5
4
6
5
> Auto-generated documentation for [ pyrlottie] ( ../../../pyrlottie/__init__.py ) module.
7
6
@@ -10,6 +9,10 @@ Pyrlottie
10
9
- [ LottieFile] ( #lottiefile )
11
10
- [ LottieFile().__ attrs_post_init__ ] ( #lottiefile()__attrs_post_init__ )
12
11
- [ LottieFrames] ( #lottieframes )
12
+ - [ _ execSubprocess] ( #_execsubprocess )
13
+ - [ _ getBinDir] ( #_getbindir )
14
+ - [ _ getTransparency] ( #_gettransparency )
15
+ - [ _ scale] ( #_scale )
13
16
- [ convMultLottie] ( #convmultlottie )
14
17
- [ convMultLottieFrames] ( #convmultlottieframes )
15
18
- [ convMultLottieTransparentFrames] ( #convmultlottietransparentframes )
@@ -66,8 +69,8 @@ LottieFile __attrs_post_init__ called by attrs.
66
69
67
70
#### Arguments
68
71
69
- - ` path ` * str* - path to the lottie file
70
- - ` data ` * dict* - python dict representing the json data. Default=None (file is read)
72
+ - [ path] ( #lottiefile ) * str* - path to the lottie file
73
+ - [ data] ( #lottiefile ) * dict* - python dict representing the json data. Default=None (file is read)
71
74
72
75
#### Raises
73
76
@@ -101,6 +104,96 @@ class LottieFrames: ...
101
104
102
105
103
106
107
+ ## _ execSubprocess
108
+
109
+ [ Show source in __ init__ .py:153] ( ../../../pyrlottie/__init__.py#L153 )
110
+
111
+ Execute a command and check for errors.
112
+
113
+ #### Arguments
114
+
115
+ - ` command ` * str* - commands as a string
116
+
117
+ #### Returns
118
+
119
+ - ` tuple[int, ` * bytes] * - tuple of return code (int) and stdout (str)
120
+
121
+ #### Signature
122
+
123
+ ``` python
124
+ async def _execSubprocess (command : str ) -> tuple[int , bytes ]: ...
125
+ ```
126
+
127
+
128
+
129
+ ## _ getBinDir
130
+
131
+ [ Show source in __ init__ .py:173] ( ../../../pyrlottie/__init__.py#L173 )
132
+
133
+ Get the binary dir using the current environment (platform.system(), platform.machine()).
134
+
135
+ #### Raises
136
+
137
+ - ` OSError ` - if the user's environment is not supported
138
+
139
+ #### Returns
140
+
141
+ - ` str ` - binDir - the binary dir
142
+
143
+ #### Signature
144
+
145
+ ``` python
146
+ def _getBinDir () -> str : ...
147
+ ```
148
+
149
+
150
+
151
+ ## _ getTransparency
152
+
153
+ [ Show source in __ init__ .py:205] ( ../../../pyrlottie/__init__.py#L205 )
154
+
155
+ Get the transparent pixels from an image with a red bg and an image with a black bg.
156
+
157
+ #### Arguments
158
+
159
+ - ` background ` * np.ndarray* - image1 (the red image)
160
+ - ` foreground ` * np.ndarray* - image2 (the black image)
161
+
162
+ #### Returns
163
+
164
+ - ` np.ndarray ` - pixels for the transparent image
165
+
166
+ #### Signature
167
+
168
+ ``` python
169
+ def _getTransparency (image1 : np.ndarray, image2 : np.ndarray) -> np.ndarray: ...
170
+ ```
171
+
172
+
173
+
174
+ ## _ scale
175
+
176
+ [ Show source in __ init__ .py:190] ( ../../../pyrlottie/__init__.py#L190 )
177
+
178
+ Get a scaled dimen.
179
+
180
+ #### Arguments
181
+
182
+ - ` dimen ` * str* - dimension in px
183
+ - ` scale ` * float* - scale
184
+
185
+ #### Returns
186
+
187
+ - ` Optional[int, ` * str] * - scaled dimen (min=1)
188
+
189
+ #### Signature
190
+
191
+ ``` python
192
+ def _scale (dimen : str , scale : float = 1 ) -> int | str : ...
193
+ ```
194
+
195
+
196
+
104
197
## convMultLottie
105
198
106
199
[ Show source in __ init__ .py:401] ( ../../../pyrlottie/__init__.py#L401 )
0 commit comments