Skip to content

Commit 09f09f6

Browse files
committed
Update README.rst
1 parent 66a7458 commit 09f09f6

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,34 @@ For instance, encode an mp3
8989
9090
transcoder = Transcoder(pipeline_id, AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
9191
92+
93+
Setting Up AWS SNS endpoint
94+
---------------------------------
95+
96+
AWS Elastic Transcoder can send various SNS notification to notify your application, like ``PROGRESS``, ``ERROR``, ``WARNING`` and ``COMPLETE``
97+
98+
So this package provide a endpoint to receieve these notifications, for you to update transcode progress. without checking by your self.
99+
100+
Go to SNS section in AWS WebConsole to choose topic and subscribe with the url below.
101+
102+
``http://<your-domain>/dj_elastictranscoder/sns_endpoint/``
103+
104+
Before notification get started to work, you have to activate SNS subscription, you will receive email with activation link.
105+
106+
After subscribe is done, you will receive SNS notification.
107+
108+
109+
Signals
110+
-----------
111+
112+
This package provide various signals for you to get notification, and do more things in your application. you can check the signals usage in tests.py for more usage example.
113+
114+
* transcode_init
115+
* transcode_onprogress
116+
* transcode_onerror
117+
* transcode_oncomplete
118+
119+
92120
.. |Build Status| image:: https://travis-ci.org/StreetVoice/django-elastic-transcoder.png?branch=master
93121
:target: https://travis-ci.org/StreetVoice/django-elastic-transcoder
94122
.. |Coverage Status| image:: https://coveralls.io/repos/StreetVoice/django-elastic-transcoder/badge.png?branch=master

0 commit comments

Comments
 (0)