001package com.github.theholywaffle.teamspeak3.api;
002
003/*
004 * #%L
005 * TeamSpeak 3 Java API
006 * %%
007 * Copyright (C) 2021 Bert De Geyter, Roger Baumgartner
008 * %%
009 * Permission is hereby granted, free of charge, to any person obtaining a copy
010 * of this software and associated documentation files (the "Software"), to deal
011 * in the Software without restriction, including without limitation the rights
012 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
013 * copies of the Software, and to permit persons to whom the Software is
014 * furnished to do so, subject to the following conditions:
015 *
016 * The above copyright notice and this permission notice shall be included in
017 * all copies or substantial portions of the Software.
018 *
019 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
020 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
021 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
022 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
023 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
024 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
025 * THE SOFTWARE.
026 * #L%
027 */
028
029/**
030 * The values in this enum are <b>speculative</b>.
031 * There does not appear to be any documentation on channel banner modes.
032 */
033public enum ChannelBannerMode {
034
035        NO_ADJUST(0),
036        IGNORE_ASPECT(1),
037        KEEP_ASPECT(2),
038
039        /**
040         * An unknown channel banner mode.
041         * <p>
042         * If you ever encounter an unknown banner mode, please tell us!
043         * We may have to update the API.
044         * </p>
045         */
046        UNKNOWN(-1);
047
048        private final int i;
049
050        ChannelBannerMode(int i) {
051                this.i = i;
052        }
053
054        public int getIndex() {
055                return i;
056        }
057}