-
Notifications
You must be signed in to change notification settings - Fork 1
/
Advanced_plugin.html
200 lines (162 loc) · 7.77 KB
/
Advanced_plugin.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
<!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>How to interact with the timeline</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="Advanced_plugin.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="how-to-interact-with-the-timeline">How to interact with the timeline</h1>
<p>Let's add a button for removing the gaps between clips!</p>
<p><img src="images/Plugins_Gap_Remover-1.gif" alt=""></p>
<p>Follow the steps in the <a href="Plugins.html">hello world example</a> to create a plugin directory and a plugin info file. What's left is to create the Python module with the logic.</p>
<h2 id="adding-the-new-button">Adding the new button</h2>
<p>Since the button is related to the timeline, we add it in the timeline toolbar, at the right of the timeline.</p>
<pre><code class="language-python">from gi.repository import GObject
from gi.repository import Gtk
from gi.repository import Peas
class GapRemover(GObject.Object, Peas.Activatable):
object = GObject.Property(type=GObject.Object)
def do_activate(self):
self.app = self.object.app
self.button = Gtk.ToolButton.new_from_stock(Gtk.STOCK_STRIKETHROUGH)
self.button.set_tooltip_text("Remove gaps between clips")
self.button.show()
toolbar = self.app.gui.editor.timeline_ui.toolbar
toolbar.add(self.button)
</code></pre>
<p>At this point, you can re-start Pitivi, activate the plugin and notice the new button in the UI!</p>
<h2 id="making-it-dance">Making it dance</h2>
<p>The interesting part is the <code>__clicked_cb</code> callback method, which is connected to the button's "clicked" signal:</p>
<pre><code class="language-python">
def do_activate(self):
...
self.button.connect("clicked", self.__clicked_cb)
def __clicked_cb(self, unused_button):
timeline = self.app.gui.editor.timeline_ui.timeline
clips = sorted(timeline.selection, key=lambda x : x.get_start())
if len(clips) >= 2:
previous = clips[0]
for clip in clips[1:]:
clip.set_start(previous.get_start() + previous.get_duration())
previous = clip
</code></pre>
<p>Finally, we can add some cleanup logic when the plugin is deactivated, because we're nice:</p>
<pre><code class="language-python"> def do_deactivate(self):
self.app.gui.editor.timeline_ui.toolbar.remove(self.button)
</code></pre>
<h2 id="making-it-shine">Making it shine</h2>
<p>The plugin can be improved by:</p>
<ul>
<li>Associating the action with a keyboard shortcut.</li>
<li>Checking whether the clips are <a href="https://www.pitivi.org/manual/selectiongrouping.html">grouped</a>, because the entire group moves when a clip in the group is moved, so they should be dealt with somehow.</li>
<li>Making the operation undoable by wrapping it in a <code>with self.app.action_log.started("add clip", toplevel=True):</code>.</li>
<li>Disabling the button automatically when <code>timeline.selection</code> contains less than two clips.</li>
<li>Making it work for the entire timeline in case there is no selection.</li>
</ul>
<p>Check out the Pitivi code and the <a href="http://lazka.github.io/pgi-docs/#GES-1.0">GES API</a> to see what can be done, and tell us what you are hacking!</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/Advanced_plugin.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>