CallbackDataSourceDesc2.java

/*
 * Copyright 2018 The Android Open Source Project
 *
 * 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 androidx.media2;

import androidx.annotation.NonNull;
import androidx.core.util.Preconditions;

/**
 * Structure for data source descriptor for {@link CallbackDataSource2}. Used by {@link MediaItem2}.
 * <p>
 * Users should use {@link Builder} to create {@link CallbackDataSourceDesc2}.
 *
 * @see MediaItem2
 */
public class CallbackDataSourceDesc2 extends DataSourceDesc2 {

    @SuppressWarnings("WeakerAccess") /* synthetic access */
            CallbackDataSource2 mCallbackDataSource2;

    CallbackDataSourceDesc2(Builder builder) {
        super(builder);
        mCallbackDataSource2 = builder.mCallbackDataSource2;
    }

    /**
     * Return the type of data source.
     * @return the type of data source
     */
    @Override
    public int getType() {
        return TYPE_CALLBACK;
    }

    /**
     * Return the CallbackDataSource2 that implements the callback for this data source.
     * @return the CallbackDataSource2 that implements the callback for this data source,
     */
    public @NonNull CallbackDataSource2 getCallbackDataSource2() {
        return mCallbackDataSource2;
    }

    /**
     * This Builder class simplifies the creation of a {@link CallbackDataSourceDesc2} object.
     */
    public static final class Builder extends DataSourceDesc2.Builder<Builder> {

        @SuppressWarnings("WeakerAccess") /* synthetic access */
                CallbackDataSource2 mCallbackDataSource2;

        /**
         * Creates a new Builder object.
         * @param m2ds the CallbackDataSource2 for the media you want to play
         */
        public Builder(@NonNull CallbackDataSource2 m2ds) {
            Preconditions.checkNotNull(m2ds);
            mCallbackDataSource2 = m2ds;
        }

        /**
         * @return A new CallbackDataSourceDesc2 with values supplied by the Builder.
         */
        public CallbackDataSourceDesc2 build() {
            return new CallbackDataSourceDesc2(this);
        }
    }
}