travel.izi.api.model.entity.Media Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-api-extended Show documentation

Java wrapper around the izi.TRAVEL API using Retrofit. Remote services are grouped into local service objects which can be centrally managed by a IZITravel instance. It will act as a factory for all of the services and will automatically initialize them with your credentials and API key.

There is a newer version: 1.6.0

Show newest version

/*
 * Copyright (C) 2014 IZITEQ B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package travel.izi.api.model.entity;

import travel.izi.api.model.IZITravelEntity;
import travel.izi.api.model.enumeration.MediaType;

/**
 * The media file details.
 */
@SuppressWarnings("unused")
public class Media implements IZITravelEntity {
    private static final long serialVersionUID = -6203198710109285963L;

    /**
     * Universally Unique Identifier of media file.
     */
    public String uuid;

    /**
     * Type of media.
     */
    public MediaType type;

    /**
     * Defines in what order to show\play media. F.e., picture with order=1 is the first(default) image to display.
     */
    public int order;

    /**
     * Duration of media file in seconds. Typical for audio, video.
     */
    public int duration;

    /**
     * Direct URL to media when a parameter media_links set to true.
     */
    public String url;

    /**
     * Title of media. Typical for {@link MediaType#Map} and {@link MediaType#Story} images.
     */
    public String title;

    /**
     * ETag hash for checking if file changed ({@link MediaType#BrandCover} and {@link MediaType#City} has no hash).
     */
    public String hash;

    /**
     * Media size in bytes ({@link MediaType#BrandCover} and {@link MediaType#City} has no size).
     * In case of images with type {@link MediaType#Story}, the size of 800x600 image version is used.
     */
    public Long size;

}