docs/README.txt
changeset 12 240f2efa4a1f
child 25 3ee119b3968f
equal deleted inserted replaced
11:967f905e1de5 12:240f2efa4a1f
       
     1 .. contents::
       
     2 
       
     3 
       
     4 Introduction
       
     5 ============
       
     6 
       
     7 pyams_media is a Pyramid/PyAMS extension package used to automatically convert and
       
     8 display medias, actually audio and video files.
       
     9 
       
    10 Medias conversion is based on FFmpeg binary, which must be available on the web server.
       
    11 
       
    12 
       
    13 Medias conversions
       
    14 ==================
       
    15 
       
    16 Medias conversion implies several pre-requisites:
       
    17 
       
    18  - the ''ffmpeg'' executable must be available in your path;
       
    19 
       
    20  - you have to rely a ZEO connection handling a blobs cache directory;
       
    21 
       
    22  - you have to create this ZEO connection in your PyAMS control panel.
       
    23 
       
    24 A PyAMS medias converter is automatically created when pyams_package is included into your configuration
       
    25 when you execute the ''pyams_upgrade'' command line tool (see ''pyams_utils'' package).
       
    26 
       
    27 
       
    28 Conversion configuration
       
    29 ========================
       
    30 
       
    31 Medias conversion is based on a specific listening process using ØMQ messages. The listening address must be defined
       
    32 in your configuration file under the key ''pyams_media.tcp_handler'', in the ''ip:port'' form. For example::
       
    33 
       
    34     pyams_media.tcp_handler = 127.0.0.1:5556
       
    35 
       
    36 PyAMS control panel allows you to define several conversion settings, for example to define which audio and video
       
    37 formats should be available, as well as a few FFmpeg conversion settings (frame size, bitrate, sampling...).
       
    38 
       
    39 Conversion is launched automatically in the background as soon as a media file is added to any content. Converted
       
    40 medias are stored in the ZODB as blob files in the original media file annotations.