-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathPlugins.html
205 lines (167 loc) · 8.13 KB
/
Plugins.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
63
64
65
66
67
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
96
97
98
99
100
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Plugins</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/pitivi.svg" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Pitivi Developer Documentation</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Pitivi" data-hotdoc-ref="Plugins.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="plugins">Plugins</h1>
<p>Pitivi's <a href="https://gitlab.gnome.org/GNOME/pitivi/blob/master/pitivi/pluginmanager.py">Plugin Manager</a> is based on <a href="https://wiki.gnome.org/Projects/Libpeas">libpeas</a>. Currently we only support plugins written in Python 3.</p>
<h2 id="location">Location</h2>
<p>There are two directories where Pitivi is looking for plugins. One is the system plugins directory, where normally you'll find the <a href="https://gitlab.gnome.org/GNOME/pitivi/blob/master/plugins">plugins we ship by default</a>. The other is the user plugins directory, where you can hack your own plugin.</p>
<p>Depending on how you installed Pitivi, these directories can have different locations. In the Plugins tab in the Preferences window you should be able to find out the location of the two directories.</p>
<h2 id="hello-world">Hello World</h2>
<p>Each plugin must have its own directory, so start with creating a directory, for example <code>hello</code>.</p>
<p>To provide some info about the plugin, create a <a href="https://developer.gnome.org/libpeas/stable/PeasPluginInfo.html">plugin info file</a>, for example <code>hello/world.plugin</code>:</p>
<pre><code class="language-ini">[Plugin]
Name=Hello World
Description=A very simple plugin.
Authors=...
website=...
Copyright=...
Loader=python3
Module=world
</code></pre>
<p>The "Loader=python3" and "Module=world" above specify the plugin is loaded from the <code>hello/world.py</code> Python module. The module should contain at least one class implementing the <a href="https://lazka.github.io/pgi-docs/#Peas-1.0/classes/Activatable.html#Peas.Activatable">Peas.Activatable</a> interface:</p>
<pre><code class="language-python">from gi.repository import GObject
from gi.repository import Peas
class HelloWorld(GObject.Object, Peas.Activatable):
object = GObject.Property(type=GObject.Object)
def do_activate(self):
print("Hello World!", self.object)
def do_deactivate(self):
print("Bye!")
</code></pre>
<p>Start Pitivi, activate the plugin in Preferences > Plugins, and notice "Hello World!" in the console.</p>
<p><img src="images/Plugins_Hello_World_preferences.png" alt=""></p>
<h2 id="api">API</h2>
<p>There is no API really. Plugins have full access to the entire app. Needless to
say, they will break sooner or later, as we refactor parts of the app. Use them
to have fun and try things out. If you think more people would be interested in
them, <a href="https://www.pitivi.org/contact/">talk with us</a> to see what we can do to
help them survive.</p>
<p>The entire Pitivi instance is provided through <code>self.object.app</code> in the <code>do_activate</code> method:</p>
<pre><code class="language-python"> def do_activate(self):
# Keep a reference to the app so you can access later
# the current project, for example.
self.app = self.object.app
# You can access the MainWindow to add your widgets, or
# change the behavior of the existing widgets.
main_window = self.app.gui
</code></pre>
<p>For an advanced example, check out how to create a plugin for <a href="Advanced_plugin.html">automating the operations with the clips in the timeline</a>.</p>
</div>
<div id="subpages">
<p><b>Subpages:</b></p>
<div class="thumb-subpages">
</div>
<p>
<a href="Advanced_plugin.html">How to interact with the timeline</a>
– An advanced plugin example
</p>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://gitlab.gnome.org/GNOME/pitivi/edit/master/docs/Plugins.md" data-hotdoc-role="edit-button">Edit on GitLab</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>