cocorum.uploadphp
The primary use from this module is the UploadPHP
class, used for uploading videos. You must first create an instance of cocorum.servicephp.ServicePHP()
, and then pass it to this class upon initialization.
All other classes are supporting sub-classes.
UploadPHP
Interact with Rumble's Upload.PHP API to upload videos. S.D.G.
UploadPHP
Upload videos to Rumble
Source code in cocorum/uploadphp.py
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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
|
session_cookie
property
Our Rumble session cookie to authenticate requests
__init__(servicephp)
Upload videos to Rumble.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
servicephp
|
ServicePHP
|
ServicePHP object, for authentication. |
required |
Source code in cocorum/uploadphp.py
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
|
ensure_valid_channel_id(channel_id)
Ensure a channel ID is numeric and a valid channel, or None
Parameters:
Name | Type | Description | Default |
---|---|---|---|
channel_id
|
(int, None)
|
The numeric ID of the channel. |
required |
Returns:
Name | Type | Description |
---|---|---|
Result |
(int, None)
|
Either the confirmed channel ID, or None if it didn't exist / wasn't specified. |
Source code in cocorum/uploadphp.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
|
uphp_request(additional_params, method='PUT', data=None, timeout=static.Delays.request_timeout)
Make a request to Upload.PHP with common settings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
additional_params
|
dict
|
Query string parameters to add to the base ones |
required |
method
|
str
|
What HTTP method to use for the request. Defaults to PUT. |
'PUT'
|
data
|
dict
|
Form data for the request. Defaults to None. |
None
|
timeout
|
(int, float)
|
Request timeout. Defaults to static.Delays.request_timeout |
request_timeout
|
Returns:
Name | Type | Description |
---|---|---|
Response |
Response
|
The response from the request. |
Source code in cocorum/uploadphp.py
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 |
|
upload_video(file_path, title, category1, **kwargs)
Upload a video to Rumble
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path
|
str
|
A valid, complete path to a video file. |
required |
title
|
str
|
The video title. |
required |
category1
|
(int, str)
|
The primary category to upload to, by name or numeric ID. |
required |
description
|
str
|
Describe the video. Defaults to empty. |
required |
info_who
|
str
|
Additional people appearing in the video. Defaults to empty. |
required |
info_when
|
str
|
When this video was recorded. Defaults to unspecified. |
required |
info_where
|
str
|
Where this video was recorded. Defaults to unspecified. |
required |
info_ext_user
|
str
|
Your username on other platforms. Defaults to unspecified. |
required |
tags
|
str
|
Comma-separated tagging for the video's topics. Defaults to empty. |
required |
category2
|
(int, str)
|
The secondary category to upload to, by name or numeric ID. Defaults to empty |
required |
channel_id
|
(int, str)
|
Numeric ID or name of the channel to upload to. Defaults to user page upload. |
required |
visibility
|
str
|
Visibility of the video, either public, unlisted, or private. Defaults to 'public'. |
required |
availability
|
TODO Defaults to free. |
required | |
scheduled_publish
|
(int, float)
|
When to publish the video to public later, in seconds since epoch. Defaults to publish immediately. |
required |
thumbnail
|
(int, str)
|
Thumbnail to use. Index 0-2 for an auto thumbnail, or a complete, valid local file path for custom. Defaults to 0, first auto thumbnail. |
required |
Returns:
Name | Type | Description |
---|---|---|
Response |
UploadResponse
|
Data about the upload, parsed from the response. |
Source code in cocorum/uploadphp.py
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
|
UploadResponse
Bases: JSONObj
Response to a successful video upload
Source code in cocorum/uploadphp.py
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 |
|
embed
property
HTML to use for embedding the video
embed_monetize
property
HTML to use for embedding the video with monetization
fid
property
The numeric ID of the uploaded video in base 10
fid_b10
property
The numeric ID of the uploaded video in base 10
fid_b36
property
The numeric ID of the uploaded video in base 36
title
property
The title of the video
url
property
The video viewing URL
S.D.G.