com.vonage.client.video.SessionStream Maven / Gradle / Ivy

Go to download
/*
 *   Copyright 2024 Vonage
 *
 *   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 com.vonage.client.video;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.vonage.client.JsonableBaseObject;
import java.util.Arrays;
import java.util.List;
import java.util.UUID;

/**
 * Represents a stream's metadata in a Vonage Video session.
 * Used for updating the stream layout in {@link VideoClient#setStreamLayout(String, List)}.
 */
public class SessionStream extends JsonableBaseObject {
	private UUID id;
	private List layoutClassList;

	protected SessionStream() {
	}

	protected SessionStream(Builder builder) {
		id = builder.id;
		layoutClassList = builder.layoutClassList;
	}

	/**
	 * @return The stream ID.
	 */
	@JsonProperty("id")
	public UUID getId() {
		return id;
	}

	/**
	 * @return The layout classes for this stream.
	 */
	@JsonProperty("layoutClassList")
	public List getLayoutClassList() {
		return layoutClassList;
	}

	/**
	 * Entry point for building an instance of .
	 *
	 * @param streamId The ID of the stream.
	 *
	 * @return A new {@linkplain Builder} with the specified streamId property.
	 */
	public static Builder builder(String streamId) {
		return new Builder(streamId);
	}

	public static class Builder {
		private final UUID id;
		private List layoutClassList;

		protected Builder(String id) {
			this.id = UUID.fromString(id);
		}

		/**
		 * Use this method to set the layout classes for the stream.
		 *
		 * @param layoutClassList The updated layout classes to use for this stream.
		 *
		 * @return This builder.
		 */
		public Builder layoutClassList(List layoutClassList) {
			this.layoutClassList = layoutClassList;
			return this;
		}

		/**
		 * Use this method to set the layout classes for the stream.
		 *
		 * @param layoutClasses The updated layout classes to use for this stream.
		 *
		 * @return This builder.
		 * @see #layoutClassList(List)
		 * @since 8.0.0-beta2
		 */
		public Builder layoutClassList(String... layoutClasses) {
			return layoutClassList(Arrays.asList(layoutClasses));
		}

		/**
		 * Constructs an instance of SessionStream.
		 *
		 * @return A new {@linkplain SessionStream} object with this builder's properties.
		 */
		public SessionStream build() {
			return new SessionStream(this);
		}
	}
}