You are here

Home » API reference » Kaltura 6.2 » KalturaClient.php

class KalturaClient in Kaltura 6.2

Same name and namespace in other branches
  1. 5 kaltura_client/kaltura_client.php \KalturaClient
  2. 6 kaltura_client/kaltura_client.php \KalturaClient

Hierarchy

Expanded class hierarchy of KalturaClient

File

kaltura_client/KalturaClient.php, line 5185

View source 
class KalturaClient extends KalturaClientBase {

  /**
   * Media service lets you upload and manage media files (images / videos & audio)
   *
   * @var KalturaMediaService
   */
  public $media = null;

  /**
   * A Mix is an XML unique format invented by Kaltura, it allows the user to create a mix of videos and images, in and out points, transitions, text overlays, soundtrack, effects and much more...
   * Mixing service lets you create a new mix, manage its metadata and make basic manipulations.
   *
   * @var KalturaMixingService
   */
  public $mixing = null;

  /**
   * Document service lets you upload and manage document files
   *
   * @var KalturaDocumentService
   */
  public $document = null;

  /**
   * Data service lets you manage data content (textual content)
   *
   * @var KalturaDataService
   */
  public $data = null;

  /**
   * Base Entry Service
   *
   * @var KalturaBaseEntryService
   */
  public $baseEntry = null;

  /**
   * Session service
   *
   * @var KalturaSessionService
   */
  public $session = null;

  /**
   * UiConf service lets you create and manage your UIConfs for the various flash components
   * This service is used by the KMC-ApplicationStudio
   *
   * @var KalturaUiConfService
   */
  public $uiConf = null;

  /**
   * Playlist service lets you create,manage and play your playlists
   * Playlists could be static (containing a fixed list of entries) or dynamic (baseed on a filter)
   *
   * @var KalturaPlaylistService
   */
  public $playlist = null;

  /**
   * Manage partner users on Kaltura's side
   * The userId in kaltura is the unique Id in the partner's system, and the [partnerId,Id] couple are unique key in kaltura's DB
   *
   * @var KalturaUserService
   */
  public $user = null;

  /**
   * widget service for full widget management
   *
   * @var KalturaWidgetService
   */
  public $widget = null;

  /**
   * Search service allows you to search for media in various media providers
   * This service is being used mostly by the CW component
   *
   * @var KalturaSearchService
   */
  public $search = null;

  /**
   * partner service allows you to change/manage your partner personal details and settings as well
   *
   * @var KalturaPartnerService
   */
  public $partner = null;

  /**
   * adminuser service
   *
   * @var KalturaAdminUserService
   */
  public $adminUser = null;

  /**
   * System Service
   *
   * @var KalturaSystemService
   */
  public $system = null;

  /**
   * Bulk Upload Service
   *
   * @var KalturaBulkUploadService
   */
  public $bulkUpload = null;

  /**
   * Notification Service
   *
   * @var KalturaNotificationService
   */
  public $notification = null;

  /**
   * batch service lets you handle different batch process from remote machines.
   * As oppesed to other ojects in the system, locking mechanism is critical in this case.
   * For this reason the GetExclusiveXXX , UpdateExclusiveXXX and FreeExclusiveXXX actions are important for the system's intergity.
   * In general - updating batch object should be done only using the UpdateExclusiveXXX which in turn can be called only after
   * acuiring a batch objet properly (using  GetExclusiveXXX).
   * If an object was aquired and should be returned to the pool in it's initial state - use the FreeExclusiveXXX action
   *
   * @var KalturaBatchService
   */
  public $batch = null;

  /**
   * api for getting reports data by the report type and some inputFilter
   *
   * @var KalturaReportService
   */
  public $report = null;

  /**
   * Conversion Profile Service
   *
   * @var KalturaConversionProfileService
   */
  public $conversionProfile = null;

  /**
   * Stats Service
   *
   * @var KalturaStatsService
   */
  public $stats = null;
  public function __construct(KalturaConfiguration $config) {
    parent::__construct($config);
    $this->media = new KalturaMediaService($this);
    $this->mixing = new KalturaMixingService($this);
    $this->document = new KalturaDocumentService($this);
    $this->data = new KalturaDataService($this);
    $this->baseEntry = new KalturaBaseEntryService($this);
    $this->session = new KalturaSessionService($this);
    $this->uiConf = new KalturaUiConfService($this);
    $this->playlist = new KalturaPlaylistService($this);
    $this->user = new KalturaUserService($this);
    $this->widget = new KalturaWidgetService($this);
    $this->search = new KalturaSearchService($this);
    $this->partner = new KalturaPartnerService($this);
    $this->adminUser = new KalturaAdminUserService($this);
    $this->system = new KalturaSystemService($this);
    $this->bulkUpload = new KalturaBulkUploadService($this);
    $this->notification = new KalturaNotificationService($this);
    $this->batch = new KalturaBatchService($this);
    $this->report = new KalturaReportService($this);
    $this->conversionProfile = new KalturaConversionProfileService($this);
    $this->stats = new KalturaStatsService($this);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
KalturaClient::$adminUser public property adminuser service
KalturaClient::$baseEntry public property Base Entry Service
KalturaClient::$batch public property batch service lets you handle different batch process from remote machines. As oppesed to other ojects in the system, locking mechanism is critical in this case. For this reason the GetExclusiveXXX , UpdateExclusiveXXX and FreeExclusiveXXX actions are…
KalturaClient::$bulkUpload public property Bulk Upload Service
KalturaClient::$conversionProfile public property Conversion Profile Service
KalturaClient::$data public property Data service lets you manage data content (textual content)
KalturaClient::$document public property Document service lets you upload and manage document files
KalturaClient::$media public property Media service lets you upload and manage media files (images / videos & audio)
KalturaClient::$mixing public property A Mix is an XML unique format invented by Kaltura, it allows the user to create a mix of videos and images, in and out points, transitions, text overlays, soundtrack, effects and much more... Mixing service lets you create a new mix, manage its…
KalturaClient::$notification public property Notification Service
KalturaClient::$partner public property partner service allows you to change/manage your partner personal details and settings as well
KalturaClient::$playlist public property Playlist service lets you create,manage and play your playlists Playlists could be static (containing a fixed list of entries) or dynamic (baseed on a filter)
KalturaClient::$report public property api for getting reports data by the report type and some inputFilter
KalturaClient::$search public property Search service allows you to search for media in various media providers This service is being used mostly by the CW component
KalturaClient::$session public property Session service
KalturaClient::$stats public property Stats Service
KalturaClient::$system public property System Service
KalturaClient::$uiConf public property UiConf service lets you create and manage your UIConfs for the various flash components This service is used by the KMC-ApplicationStudio
KalturaClient::$user public property Manage partner users on Kaltura's side The userId in kaltura is the unique Id in the partner's system, and the [partnerId,Id] couple are unique key in kaltura's DB
KalturaClient::$widget public property widget service for full widget management
KalturaClient::__construct public function * Kaltura client constructor * * Overrides KalturaClientBase::__construct
KalturaClientBase::$callsQueue private property *
KalturaClientBase::$config private property *
KalturaClientBase::$isMultiRequest private property *
KalturaClientBase::$ks private property *
KalturaClientBase::$shouldLog private property *
KalturaClientBase::addParam public function * Add parameter to array of parameters that is passed by reference * *
KalturaClientBase::doCurl private function * Curl HTTP POST Request * *
KalturaClientBase::doHttpRequest private function * Send http request by using curl (if available) or php stream_context * *
KalturaClientBase::doMultiRequest public function
KalturaClientBase::doPostRequest private function * HTTP stream context request * *
KalturaClientBase::doQueue public function * Call all API service that are in queue * *
KalturaClientBase::getConfig public function *
KalturaClientBase::getKs public function *
KalturaClientBase::isError public function * Checks whether the result object is an error * *
KalturaClientBase::isMultiRequest public function
KalturaClientBase::KALTURA_API_VERSION constant
KalturaClientBase::KALTURA_SERVICE_FORMAT_JSON constant
KalturaClientBase::KALTURA_SERVICE_FORMAT_PHP constant
KalturaClientBase::KALTURA_SERVICE_FORMAT_XML constant
KalturaClientBase::log protected function *
KalturaClientBase::queueServiceActionCall public function
KalturaClientBase::setConfig public function *
KalturaClientBase::setKs public function *
KalturaClientBase::signature private function * Sign array of parameters * *
KalturaClientBase::startMultiRequest public function
KalturaClientBase::throwExceptionIfError public function * Validate the result object and throw exception if its an error * *
KalturaClientBase::validateObjectType public function * Validate that the passed object type is of the expected type * *