org.fourthline.cling.model.gena.GENASubscription Java Examples

public OutgoingEventRequestMessage(GENASubscription subscription,
                                   URL callbackURL,
                                   UnsignedIntegerFourBytes sequence,
                                   Collection<StateVariableValue> values) {

    super(new UpnpRequest(UpnpRequest.Method.NOTIFY, callbackURL));

    getHeaders().add(UpnpHeader.Type.CONTENT_TYPE, new ContentTypeHeader());
    getHeaders().add(UpnpHeader.Type.NT, new NTEventHeader());
    getHeaders().add(UpnpHeader.Type.NTS, new NTSHeader(NotificationSubtype.PROPCHANGE));
    getHeaders().add(UpnpHeader.Type.SID, new SubscriptionIdHeader(subscription.getSubscriptionId()));

    // Important! Pass by value so that we can safely increment it afterwards and before this is send!
    getHeaders().add(UpnpHeader.Type.SEQ, new EventSequenceHeader(sequence.getValue()));

    this.stateVariableValues = values;
}
 

public OutgoingEventRequestMessage(GENASubscription subscription,
                                   URL callbackURL,
                                   UnsignedIntegerFourBytes sequence,
                                   Collection<StateVariableValue> values) {

    super(new UpnpRequest(UpnpRequest.Method.NOTIFY, callbackURL));

    getHeaders().add(UpnpHeader.Type.CONTENT_TYPE, new ContentTypeHeader());
    getHeaders().add(UpnpHeader.Type.NT, new NTEventHeader());
    getHeaders().add(UpnpHeader.Type.NTS, new NTSHeader(NotificationSubtype.PROPCHANGE));
    getHeaders().add(UpnpHeader.Type.SID, new SubscriptionIdHeader(subscription.getSubscriptionId()));

    // Important! Pass by value so that we can safely increment it afterwards and before this is send!
    getHeaders().add(UpnpHeader.Type.SEQ, new EventSequenceHeader(sequence.getValue()));

    this.stateVariableValues = values;
}
 

@Override
protected void ended(GENASubscription subscription, CancelReason reason, UpnpResponse responseStatus) {
    Log.i(TAG, "AVTransportSubscriptionCallback ended.");
}
 

@Override
public void create(final boolean playing, final int seconds) {
	downloadService.setPlayerState(PlayerState.PREPARING);

	callback = new SubscriptionCallback(getTransportService(), 600) {
		@Override
		protected void failed(GENASubscription genaSubscription, UpnpResponse upnpResponse, Exception e, String msg) {
			Log.w(TAG, "Register subscription callback failed: " + msg, e);
		}

		@Override
		protected void established(GENASubscription genaSubscription) {
			Action seekAction = genaSubscription.getService().getAction("Seek");
			if(seekAction != null) {
				StateVariable seekMode = genaSubscription.getService().getStateVariable("A_ARG_TYPE_SeekMode");
				for(String allowedValue: seekMode.getTypeDetails().getAllowedValues()) {
					if("REL_TIME".equals(allowedValue)) {
						supportsSeek = true;
					}
				}
			}
			Action setupNextAction = genaSubscription.getService().getAction("SetNextAVTransportURI");
			if(setupNextAction != null) {
				supportsSetupNext = true;
			}

			startSong(downloadService.getCurrentPlaying(), playing, seconds);
			downloadService.postDelayed(searchDLNA, SEARCH_UPDATE_INTERVAL_SECONDS);
		}

		@Override
		protected void ended(GENASubscription genaSubscription, CancelReason cancelReason, UpnpResponse upnpResponse) {
			Log.i(TAG, "Ended subscription");
			if(cancelReason != null) {
				Log.i(TAG, "Cancel Reason: " + cancelReason.toString());
			}
			if(upnpResponse != null) {
				Log.i(TAG, "Reponse Message: " + upnpResponse.getStatusMessage());
				Log.i(TAG, "Response Details: " + upnpResponse.getResponseDetails());
			}
		}

		@Override
		protected void eventReceived(GENASubscription genaSubscription) {
			Map<String, StateVariableValue> m = genaSubscription.getCurrentValues();
			try {
				String lastChangeText = m.get("LastChange").toString();
				lastChangeText = lastChangeText.replace(",X_DLNA_SeekTime","").replace(",X_DLNA_SeekByte", "");
				LastChange lastChange = new LastChange(new AVTransportLastChangeParser(), lastChangeText);

				if (lastChange.getEventedValue(0, AVTransportVariable.TransportState.class) == null) {
					return;
				}

				switch (lastChange.getEventedValue(0, AVTransportVariable.TransportState.class).getValue()) {
					case PLAYING:
						downloadService.setPlayerState(PlayerState.STARTED);
						break;
					case PAUSED_PLAYBACK:
						downloadService.setPlayerState(PlayerState.PAUSED);
						break;
					case STOPPED:
						boolean failed = false;
						for(StateVariableValue val: m.values()) {
							if(val.toString().indexOf("TransportStatus val=\"ERROR_OCCURRED\"") != -1) {
								Log.w(TAG, "Failed to load with event: " + val.toString());
								failed = true;
							}
						}

						if(failed) {
							failedLoad();
						} else if(downloadService.getPlayerState() == PlayerState.STARTED) {
							// Played until the end
							downloadService.onSongCompleted();
						} else {
							downloadService.setPlayerState(PlayerState.STOPPED);
						}
						break;
					case TRANSITIONING:
						downloadService.setPlayerState(PlayerState.PREPARING);
						break;
					case NO_MEDIA_PRESENT:
						downloadService.setPlayerState(PlayerState.IDLE);
						break;
					default:
				}
			}
			catch (Exception e) {
				Log.w(TAG, "Failed to parse UPNP event", e);
			}
		}

		@Override
		protected void eventsMissed(GENASubscription genaSubscription, int i) {
			Log.w(TAG, "Event missed: " + i);
		}
	};
	controlPoint.execute(callback);
}
 

protected void failed(GENASubscription subscription, UpnpResponse responseStatus, Exception exception) {
    failed(subscription, responseStatus, exception, createDefaultFailureMessage(responseStatus, exception));
}
 

synchronized public void setSubscription(GENASubscription subscription) {
    this.subscription = subscription;
}
 

synchronized public GENASubscription getSubscription() {
    return subscription;
}
 

public OutgoingEventRequestMessage(GENASubscription subscription, URL callbackURL) {
    this(subscription, callbackURL, subscription.getCurrentSequence(), subscription.getCurrentValues().values());
}
 

@Override
protected void eventsMissed(GENASubscription subscription, int numberOfMissedEvents) {
}
 

@Override
protected void established(GENASubscription subscription) {
}
 

@Override
protected void failed(GENASubscription subscription, UpnpResponse responseStatus, Exception exception, String defaultMsg) {
    Log.e(TAG, "AVTransportSubscriptionCallback failed.");
}
 

protected void failed(GENASubscription subscription, UpnpResponse responseStatus, Exception exception) {
    failed(subscription, responseStatus, exception, createDefaultFailureMessage(responseStatus, exception));
}
 

synchronized public void setSubscription(GENASubscription subscription) {
    this.subscription = subscription;
}
 

synchronized public GENASubscription getSubscription() {
    return subscription;
}
 

public OutgoingEventRequestMessage(GENASubscription subscription, URL callbackURL) {
    this(subscription, callbackURL, subscription.getCurrentSequence(), subscription.getCurrentValues().values());
}
 

/**
 * Called when a received event was out of sequence, indicating that events have been missed.
 * <p>
 * It's up to you if you want to react to missed events or if you (can) silently ignore them.
 * </p>
 * @param subscription The established subscription.
 * @param numberOfMissedEvents The number of missed events.
 */
protected abstract void eventsMissed(GENASubscription subscription, int numberOfMissedEvents);
 

/**
 * Called when an event for an established subscription has been received.
 * <p>
 * Use the {@link org.fourthline.cling.model.gena.GENASubscription#getCurrentValues()} method to obtain
 * the evented state variable values.
 * </p>
 *
 * @param subscription The established subscription with fresh state variable values.
 */
protected abstract void eventReceived(GENASubscription subscription);
 

/**
 * Called when a local or remote subscription ended, either on user request or because of a failure.
 *
 * @param subscription   The ended subscription instance.
 * @param reason         If the subscription ended regularly (through <tt>end()</tt>), this is <tt>null</tt>.
 * @param responseStatus For a remote subscription, if the cause implies a remopte response and it was
 *                       received, this is it (e.g. renewal failure response).
 */
protected abstract void ended(GENASubscription subscription, CancelReason reason, UpnpResponse responseStatus);
 

/**
 * Called when a local or remote subscription was successfully established.
 *
 * @param subscription The successful subscription.
 */
protected abstract void established(GENASubscription subscription);
 

/**
 * Called when establishing a local or remote subscription failed. To get a nice error message that
 * transparently detects local or remote errors use <tt>createDefaultFailureMessage()</tt>.
 *
 * @param subscription   The failed subscription object, not very useful at this point.
 * @param responseStatus For a remote subscription, if a response was received at all, this is it, otherwise <tt>null</tt>.
 * @param exception      For a local subscription and failed creation of a remote subscription protocol (before
 *                       sending the subscribe request), any exception that caused the failure, otherwise <tt>null</tt>.
 * @param defaultMsg     A user-friendly error message.
 * @see #createDefaultFailureMessage
 */
protected abstract void failed(GENASubscription subscription, UpnpResponse responseStatus, Exception exception, String defaultMsg);
 

/**
 * Called when establishing a local or remote subscription failed. To get a nice error message that
 * transparently detects local or remote errors use <tt>createDefaultFailureMessage()</tt>.
 *
 * @param subscription   The failed subscription object, not very useful at this point.
 * @param responseStatus For a remote subscription, if a response was received at all, this is it, otherwise <tt>null</tt>.
 * @param exception      For a local subscription and failed creation of a remote subscription protocol (before
 *                       sending the subscribe request), any exception that caused the failure, otherwise <tt>null</tt>.
 * @param defaultMsg     A user-friendly error message.
 * @see #createDefaultFailureMessage
 */
protected abstract void failed(GENASubscription subscription, UpnpResponse responseStatus, Exception exception, String defaultMsg);
 

/**
 * Called when a local or remote subscription was successfully established.
 *
 * @param subscription The successful subscription.
 */
protected abstract void established(GENASubscription subscription);
 

/**
 * Called when a local or remote subscription ended, either on user request or because of a failure.
 *
 * @param subscription   The ended subscription instance.
 * @param reason         If the subscription ended regularly (through <tt>end()</tt>), this is <tt>null</tt>.
 * @param responseStatus For a remote subscription, if the cause implies a remopte response and it was
 *                       received, this is it (e.g. renewal failure response).
 */
protected abstract void ended(GENASubscription subscription, CancelReason reason, UpnpResponse responseStatus);
 

/**
 * Called when an event for an established subscription has been received.
 * <p>
 * Use the {@link org.fourthline.cling.model.gena.GENASubscription#getCurrentValues()} method to obtain
 * the evented state variable values.
 * </p>
 *
 * @param subscription The established subscription with fresh state variable values.
 */
protected abstract void eventReceived(GENASubscription subscription);
 

/**
 * Called when a received event was out of sequence, indicating that events have been missed.
 * <p>
 * It's up to you if you want to react to missed events or if you (can) silently ignore them.
 * </p>
 * @param subscription The established subscription.
 * @param numberOfMissedEvents The number of missed events.
 */
protected abstract void eventsMissed(GENASubscription subscription, int numberOfMissedEvents);