filestack/filestack-php

View on GitHub
docs/traits/Filestack_Mixins_TransformationMixin/sendVideoConvert.html

Summary

Maintainability
Test Coverage
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  <head>
    <title>phpDox - Filestack\Mixins\TransformationMixin::sendVideoConvert</title>
    <link rel="stylesheet" type="text/css" href="../../css/style.css" media="screen"/>
    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  </head>
  <body>
    <nav class="topnav">
      <ul>
        <li>
          <div class="logo"><span>/**</span>phpDox</div>
        </li>
        <li class="separator">
          <a href="../../index.html">Overview</a>
        </li>
        <li class="separator">
          <a href="../../namespaces.html">Namespaces</a>
        </li>
        <li>
          <a href="../../classes.html">Classes</a>
        </li>
        <li>
          <a href="../../traits.html">Traits</a>
        </li>
        <li class="separator">
          <a href="../../source/index.html">Source</a>
        </li>
      </ul>
    </nav>
    <div id="mainstage">
      <div class="box">
        <ul class="breadcrumb">
          <li>
            <a href="../../index.html">Overview</a>
          </li>
          <li class="separator">
            <a href="../../classes.html">Classes</a>
          </li>
          <li class="separator">
            <a href="../../classes.html#Filestack_Mixins">Filestack\Mixins</a>
          </li>
          <li class="separator">
            <a title="Filestack\Mixins\TransformationMixin" href="../../traits/Filestack_Mixins_TransformationMixin.html">TransformationMixin</a>
          </li>
          <li class="separator">sendVideoConvert</li>
        </ul>
      </div>
      <nav class="box">
        <ul>
          <li>
            <a href="#introduction">Introduction</a>
          </li>
          <li>
            <a href="#synopsis">Synopsis</a>
          </li>
          <li>
            <a href="#parameter">Parameter</a>
          </li>
          <li>
            <a href="#return">Return</a>
          </li>
          <li>
            <a href="#throws">Throws</a>
          </li>
          <li>
            <a href="../../source/mixins/TransformationMixin.php.html#line152">Source</a>
          </li>
        </ul>
      </nav>
      <section>
        <h1><small>Filestack\Mixins\TransformationMixin::</small>sendVideoConvert</h1>
        <h4>Send video_convert request to API</h4>
        <p/>
        <ul/>
        <h2 id="signature">Signature</h2>
        <div class="styled synopsis">
          <code>public function sendVideoConvert(string
        $resource,
            array
        $transform_tasks,
            [<a title="Filestack\Mixins\FilestackSecurity" href="../../traits/Filestack_Mixins_FilestackSecurity.html">FilestackSecurity</a>
        $security = NULL,
            [boolean
        $force = false]] )
            </code>
        </div>
        <h2 id="parameterlist">Parameters</h2>
        <dl class="styled">
          <dt><code>$resource</code>
                —
                string</dt>
          <dd>url or filestack handle</dd>
          <dt><code>$transform_tasks</code>
                —
                array</dt>
          <dd>array of transformation tasks</dd>
          <dt><code>$security</code>
                —
                object</dt>
          <dd>Filestack Security object if<br/>enabled</dd>
          <dt><code>$force</code>
                —
                boolean</dt>
          <dd/>
        </dl>
        <h2 id="return">Returns</h2>
        <dl class="styled">
          <dt>string</dt>
          <dd>(uuid of conversion task)</dd>
        </dl>
        <h2 id="throws">Errors/Exceptions</h2>
        <dl class="styled">
          <dt>
            <code>
              <a title="Filestack\FilestackException" href="../../traits/Filestack_FilestackException.html">FilestackException</a>
            </code>
          </dt>
          <dd>if API call fails, e.g 404 file not found</dd>
        </dl>
      </section>
    </div>
    <footer>
      <span>Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
    </footer>
  </body>
</html>