forked from stvalxv/vectorly
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathvectorly.html
More file actions
166 lines (141 loc) · 9.69 KB
/
vectorly.html
File metadata and controls
166 lines (141 loc) · 9.69 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module vectorly</title>
<meta charset="utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>vectorly</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/stv/project/vectorly/vectorly/vectorly.py">/home/stv/project/vectorly/vectorly/vectorly.py</a></font></td></tr></table>
<p><tt><a href="#Vectorly">Vectorly</a> Python Client<br>
<a href="#Vectorly">Vectorly</a>'s Python library enables provides a Python wrapper for the API, enabling you to:<br>
<br>
Upload videos in bulk<br>
List current videos<br>
Search video<br>
Download video<br>
Retrieve analytics</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="vectorly.html#Vectorly">Vectorly</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="vectorly.html#VectorlyError">VectorlyError</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Vectorly">class <strong>Vectorly</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>https://vectorly.io/docs/api/<br>
The API lets you perform the following operations on your videos:<br>
upload<br>
list<br>
video_detail<br>
search<br>
download<br>
analytics<br>
events<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Vectorly-__init__"><strong>__init__</strong></a>(self, api_key, chunk_size<font color="#909090">=None</font>)</dt><dd><tt>You can get your API key in the "Settings page"<br>
:param api_key: your API key<br>
:param chunk_size: Chunk size</tt></dd></dl>
<dl><dt><a name="Vectorly-analytics"><strong>analytics</strong></a>(self)</dt><dd><tt>Overall summary of video playback over the last 30 days<br>
url = https://api.vectorly.io/analytics/summary<br>
:return:</tt></dd></dl>
<dl><dt><a name="Vectorly-download"><strong>download</strong></a>(self, video_id, destination)</dt><dd><tt>Download the compressed video to your system<br>
url = https://api.vectorly.io/videos/download/<video-id><br>
:param video_id: Video ID<br>
:param destination: Destination file<br>
:return:</tt></dd></dl>
<dl><dt><a name="Vectorly-events"><strong>events</strong></a>(self, video_id<font color="#909090">=None</font>)</dt><dd><tt>Retrieve all events from the last 90 days for a particular video<br>
url = https://api.vectorly.io/analytics/events/video/[video-id]<br>
:param video_id: Video ID<br>
:return:</tt></dd></dl>
<dl><dt><a name="Vectorly-list"><strong>list</strong></a>(self)</dt><dd><tt>Listing videos in <a href="#Vectorly">Vectorly</a><br>
When videos have the status "ready", you can begin playing the video, or you can download it<br>
url = https://api.vectorly.io/videos/list<br>
:return: List of dictionary</tt></dd></dl>
<dl><dt><a name="Vectorly-search"><strong>search</strong></a>(self, search_term)</dt><dd><tt>Searching videos<br>
The search term is case insensitive.<br>
url = https://api.vectorly.io/videos/search/<search-term><br>
:param search_term: Search term<br>
:return: List of matches dictionary</tt></dd></dl>
<dl><dt><a name="Vectorly-upload"><strong>upload</strong></a>(self, filename)</dt><dd><tt>Upload videos to <a href="#Vectorly">Vectorly</a><br>
:param filename: File name<br>
:return:</tt></dd></dl>
<dl><dt><a name="Vectorly-video_detail"><strong>video_detail</strong></a>(self, video_id)</dt><dd><tt>Getting video details by video_id<br>
url = https://api.vectorly.io/videos/get/[upload-id]<br>
:param video_id: Video ID<br>
:return: Dictionary {'id': str, 'name': str, 'status': str, 'upload_id': str, 'original_size': int, 'private': Bool, 'size': Int}}</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="VectorlyError">class <strong>VectorlyError</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="vectorly.html#VectorlyError">VectorlyError</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="VectorlyError-__init__"><strong>__init__</strong></a>(self, message, response<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="VectorlyError-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#VectorlyError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="VectorlyError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#VectorlyError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="VectorlyError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#VectorlyError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="VectorlyError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#VectorlyError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="VectorlyError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#VectorlyError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="VectorlyError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="VectorlyError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#VectorlyError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="VectorlyError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#VectorlyError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="VectorlyError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="VectorlyError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table></td></tr></table>
</body></html>