Skip to content

Commit 1784cc7

Browse files
readme updated
1 parent 9d0fc0b commit 1784cc7

File tree

7 files changed

+600
-1
lines changed

7 files changed

+600
-1
lines changed

README.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,57 @@
1-
# qencode-api-php-client
1+
# qencode-api-php-client
2+
====================
3+
PHP library for interacting with the Qencode API.
4+
5+
### Installation
6+
7+
Get composer, run this in your project directory:
8+
```bash
9+
curl -sS https://getcomposer.org/installer | php
10+
```
11+
12+
Create composer.json under the root of your project with the following instructions:
13+
```json
14+
{
15+
"require": {
16+
"qencode/api-client": "1.0.*"
17+
},
18+
"autoload": {
19+
"classmap": [
20+
"vendor/qencode/api-client/src/"
21+
]
22+
}
23+
}
24+
```
25+
Run composer:
26+
```bash
27+
php composer.phar install
28+
```
29+
30+
If you don't use composer, use autoload.php located in the root of the repo:
31+
```php
32+
require_once __DIR__ . '/../autoload.php';
33+
```
34+
35+
### Usage
36+
37+
Instantiate Qencode API Client:
38+
```php
39+
$q = new QencodeApiClient($apiKey);
40+
```
41+
42+
43+
Create a new job:
44+
45+
```php
46+
$task = $q->createTask();
47+
$task->start($transcodingProfileId, $video_url);
48+
```
49+
50+
Query an existing job:
51+
52+
```php
53+
$response = $task->getStatus();
54+
```
55+
56+
## Copyright
57+
Copyright 2018 Qencode, Inc.

0 commit comments

Comments
 (0)