shaka-packager/html/tutorials/playready.html

215 lines
10 KiB
HTML
Raw Normal View History

2018-02-10 23:37:42 +00:00
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
2018-08-16 00:35:22 +00:00
<title>Using PlayReady Key Server &#8212; Shaka Packager documentation</title>
<link rel="stylesheet" href="../_static/sphinxdoc_new.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/table_styling.css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Using Raw Key" href="raw_key.html" />
2018-08-16 00:35:22 +00:00
<link rel="prev" title="Using Widevine Key Server" href="widevine.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="raw_key.html" title="Using Raw Key"
accesskey="N">next</a> |</li>
<li class="right" >
2018-08-16 00:35:22 +00:00
<a href="widevine.html" title="Using Widevine Key Server"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Shaka Packager documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="tutorials.html" >Tutorials</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="drm.html" accesskey="U">DRM</a> &#187;</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table of Contents</a></h3>
2018-08-16 00:35:22 +00:00
<ul>
<li><a class="reference internal" href="#">Using PlayReady Key Server</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#configuration-options">Configuration options</a><ul>
2018-08-16 00:35:22 +00:00
<li><a class="reference internal" href="#drm-related-stream-descriptor-fields">DRM related Stream descriptor fields</a></li>
<li><a class="reference internal" href="#general-encryption-options">General encryption options</a></li>
<li><a class="reference internal" href="#playready-encryption-options">PlayReady encryption options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="widevine.html"
2018-08-16 00:35:22 +00:00
title="previous chapter">Using Widevine Key Server</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="raw_key.html"
title="next chapter">Using Raw Key</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/tutorials/playready.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
2018-08-16 00:35:22 +00:00
<div class="section" id="using-playready-key-server">
<h1>Using PlayReady Key Server<a class="headerlink" href="#using-playready-key-server" title="Permalink to this headline"></a></h1>
<p>Shaka Packager can talk to PlayReady Key Server that implements
<a class="reference external" href="http://bit.ly/2M9NuOt">AcquirePackagingData Web Method specification</a> to
fetch encryption keys.</p>
<p>Refer to <a class="reference internal" href="drm.html"><span class="doc">DRM</span></a> if you are interested in generating multi-DRM
contents.</p>
<div class="section" id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ packager &lt;stream_descriptor&gt; ... \
--enable_playready_encryption \
--playready_server_url &lt;playready_server_url&gt; \
--program_identifier &lt;program_identifier&gt; \
--client_cert_file &lt;client_cert_file&gt; \
--client_cert_private_key_file &lt;client_cert_private_key_file&gt; \
--client_cert_private_key_password &lt;client_cert_private_key_password&gt; \
--ca_file &lt;ca_file&gt; \
[Other options, e.g. DASH options, HLS options]
</pre></div>
</div>
2018-08-16 00:35:22 +00:00
<p>The client_cert_xx and ca_file parameters can be omitted if not required by
the key server.</p>
</div>
<div class="section" id="configuration-options">
<h2>Configuration options<a class="headerlink" href="#configuration-options" title="Permalink to this headline"></a></h2>
2018-08-16 00:35:22 +00:00
<div class="section" id="drm-related-stream-descriptor-fields">
<h3>DRM related Stream descriptor fields<a class="headerlink" href="#drm-related-stream-descriptor-fields" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">skip_encryption=0|1</dt>
<dd class="field-odd"><p>Optional. Defaults to 0 if not specified. If it is set to 1, no encryption
of the stream will be made.</p>
</dd>
<dt class="field-even">drm_label</dt>
<dd class="field-even"><p>Optional value for custom DRM label, which defines the encryption key
2018-08-16 00:35:22 +00:00
applied to the stream. Typically values include AUDIO, SD, HD, UHD1, UHD2.
For raw key, it should be a label defined in keys. If not provided, the
DRM label is derived from stream type (video, audio), resolutions, etc.
Note that it is case sensitive.</p>
</dd>
</dl>
2018-08-16 00:35:22 +00:00
</div>
<div class="section" id="general-encryption-options">
<h3>General encryption options<a class="headerlink" href="#general-encryption-options" title="Permalink to this headline"></a></h3>
<dl class="option-list">
<dt><kbd><span class="option">--protection_scheme <var>&lt;scheme&gt;</var></span></kbd></dt>
<dd><p>Specify a protection scheme, cenc or cbc1 or pattern-based protection
schemes cens or cbcs.</p>
</dd>
<dt><kbd><span class="option">--vp9_subsample_encryption</span>, <span class="option">--novp9_subsample_encryption</span></kbd></dt>
<dd><p>Enable / disable VP9 subsample encryption. Enabled by default.</p>
</dd>
<dt><kbd><span class="option">--clear_lead <var>&lt;seconds&gt;</var></span></kbd></dt>
<dd><p>Clear lead in seconds if encryption is enabled.
Shaka Packager does not support partial encrypted segments, all the
segments including the partial segment overlapping with the initial
clear_lead seconds are not encrypted, with all the following segments
encrypted. If segment_duration is greater than clear_lead, then only the
first segment is not encrypted.
Default: 5</p>
</dd>
<dt><kbd><span class="option">--protection_systems</span></kbd></dt>
<dd><p>Protection systems to be generated. Supported protection systems include
Widevine, PlayReady, FairPlay, Marlin, and
CommonSystem (<a class="reference external" href="https://goo.gl/s8RIhr">https://goo.gl/s8RIhr</a>).</p>
</dd>
</dl>
2018-08-16 00:35:22 +00:00
</div>
<div class="section" id="playready-encryption-options">
<h3>PlayReady encryption options<a class="headerlink" href="#playready-encryption-options" title="Permalink to this headline"></a></h3>
<dl class="option-list">
<dt><kbd><span class="option">--enable_playready_encryption</span></kbd></dt>
<dd><p>Enable encryption with PlayReady key. This generates PlayReady protection
2018-08-16 00:35:22 +00:00
system if protection_systems is not specified. Use protection_system to
generate multiple protection systems.</p>
</dd>
<dt><kbd><span class="option">--playready_server_url <var>&lt;url&gt;</var></span></kbd></dt>
<dd><p>PlayReady packaging server url.</p>
</dd>
<dt><kbd><span class="option">--program_identifier <var>&lt;program_identifier&gt;</var></span></kbd></dt>
<dd><p>Program identifier for packaging request.</p>
</dd>
<dt><kbd><span class="option">--ca_file <var>&lt;file path&gt;</var></span></kbd></dt>
<dd><p>Absolute path to the certificate authority file for the server cert.
PEM format. Optional, depends on server configuration.</p>
</dd>
<dt><kbd><span class="option">--client_cert_file <var>&lt;file path&gt;</var></span></kbd></dt>
<dd><p>Absolute path to client certificate file. Optional, depends on server
configuration.</p>
</dd>
<dt><kbd><span class="option">--client_cert_private_key_file <var>&lt;file path&gt;</var></span></kbd></dt>
<dd><p>Absolute path to the private key file. Optional, depends on server
configuration.</p>
</dd>
<dt><kbd><span class="option">--client_cert_private_key_password <var>&lt;string&gt;</var></span></kbd></dt>
<dd><p>Password to the private key file. Optional, depends on server configuration.</p>
</dd>
</dl>
2018-08-16 00:35:22 +00:00
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="raw_key.html" title="Using Raw Key"
>next</a> |</li>
<li class="right" >
2018-08-16 00:35:22 +00:00
<a href="widevine.html" title="Using Widevine Key Server"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Shaka Packager documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="tutorials.html" >Tutorials</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="drm.html" >DRM</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2017, Google.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
</div>
</body>
</html>