<?php
/**
 * Copyright 2006 - 2014 TubePress LLC (http://tubepress.com)
 *
 * This file is part of TubePress (http://tubepress.com)
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

/**
 * Public TubePress template variables. These variables are considered
 * safe for use by anyone, so don't mess with this list without serious
 * consideration!
 */
class tubepress_api_const_template_Variable
{
    /**
     * @api
     * @since 3.1.0
     */
    const EMBEDDED_AUTOSTART       = 'autostart';

    /**
     * @api
     * @since 3.1.0
     */
    const EMBEDDED_COLOR_HIGHLIGHT = 'embeddedColorHightlight';

    /**
     * @api
     * @since 3.1.0
     */
    const EMBEDDED_COLOR_PRIMARY   = 'embeddedColorPrimary';

    /**
     * @api
     * @since 3.1.0
     */
    const EMBEDDED_DATA_URL        = 'homeURL';

    /**
     * @api
     * @since 3.1.0
     */
    const EMBEDDED_FULLSCREEN      = 'embeddedFullscreen';

    /**
     * @api
     * @since 3.1.0
     */
    const EMBEDDED_HEIGHT          = 'embeddedHeight';

    /**
     * @api
     * @since 3.1.0
     */
    const EMBEDDED_IMPL_NAME       = 'embeddedImplementationName';

    /**
     * @api
     * @since 3.1.0
     */
    const EMBEDDED_SOURCE          = 'embeddedSource';

    /**
     * @api
     * @since 3.1.0
     */
    const EMBEDDED_WIDTH           = 'embeddedWidth';

    /**
     * @api
     * @since 3.1.0
     */
    const GALLERY_ID               = 'galleryId';

    /**
     * @api
     * @since 3.1.0
     */
    const META_LABELS              = 'metaLabels';

    /**
     * @api
     * @since 3.1.0
     */
    const META_SHOULD_SHOW         = 'shouldShow';

    /**
     * @api
     * @since 3.1.0
     */
    const PAGINATION_BOTTOM        = 'bottomPagination';

    /**
     * @api
     * @since 3.1.0
     */
    const PAGINATION_TOP           = 'topPagination';

    /**
     * @api
     * @since 3.1.0
     */
    const PLAYER_HTML              = 'preGallery';

    /**
     * @api
     * @since 3.1.0
     */
    const PLAYER_NAME              = 'playerName';

    /**
     * @api
     * @since 3.1.0
     */
    const SEARCH_HANDLER_URL       = 'searchHandlerUrl';

    /**
     * @api
     * @since 3.1.0
     */
    const SEARCH_HIDDEN_INPUTS     = 'searchHiddenInputs';

    /**
     * @api
     * @since 3.1.0
     */
    const SEARCH_BUTTON            = 'searchButton';

    /**
     * @api
     * @since 3.1.0
     */
    const SEARCH_TARGET_DOM_ID     = 'searchTargetDomId';

    /**
     * @api
     * @since 3.1.0
     */
    const SEARCH_TERMS             = 'searchTerms';

    /**
     * @api
     * @since 3.1.0
     */
    const THUMBNAIL_HEIGHT         = 'thumbHeight';

    /**
     * @api
     * @since 3.1.0
     */
    const THUMBNAIL_WIDTH          = 'thumbWidth';

    /**
     * @api
     * @since 3.1.0
     */
    const TUBEPRESS_BASE_URL       = 'tubepressBaseUrl';

    /**
     * @api
     * @since 3.1.0
     */
    const VIDEO_ARRAY              = 'videoArray';

    /**
     * @api
     * @since 3.1.0
     */
    const VIDEO                    = 'video';

    /**
     * @api
     * @since 3.1.0
     */
    const VIDEO_ID                 = 'videoId';

    /**
     * @api
     * @since 3.1.0
     */
    const VIDEO_DOM_ID             = 'videoDomId';

    /**
     * @api
     * @since 3.1.0
     */
    const VIDEO_PROVIDER_NAME      = 'videoProviderName';
}