Package com.oracle.sdp.mgs.api

Interface MediaGatewayServiceApi

public interface MediaGatewayServiceApi
MediaGatewayServiceApi provides operations for creating, modifying, activating, deactivating, and deleting media sessions in the Media Gateway Service (MGS) module.

This interface is intended for injection into UAAPPs.

Supported operations:

  • Create a new media session
  • Modify an existing session
  • Activate or deactivate a session
  • Delete a session
Example usage: 
 
 MediaFactory factory = MediaFactory.getInstance();
 MediaGatewayServiceApi api = factory.createMediaGatewayServiceApi();

Author:
Copyright (c) 2025 by Oracle, Inc. All Rights Reserved.

  • Method Details

    • createMediaSession

      MediaSessionUpsertResponse createMediaSession(CreateMediaRequest req)
      Creates a new media session by invoking the MFE API.
      Parameters:
      req - the request to create the media session
      Returns:
      the response containing the session ID or error details

    • modifyMediaSession

      MediaSessionUpsertResponse modifyMediaSession(String id, ModifyMediaRequest req)
      Modifies an existing media session with the specified ID.
      Parameters:
      id - the ID of the media session to modify
      req - the request to modify the media session
      Returns:
      the response for the modification

    • activateMediaSession

      MediaSessionUpsertResponse activateMediaSession(String id, MediaSessionActionRequest req)
      Activates a media session.
      Parameters:
      id - the session ID to activate
      req - the action request (reason should be "activate")
      Returns:
      the response after the activation attempt

    • deactivateMediaSession

      MediaSessionUpsertResponse deactivateMediaSession(String id, MediaSessionActionRequest req)
      Deactivates a media session.
      Parameters:
      id - the session ID to deactivate
      req - the action request (reason should be "deactivate")
      Returns:
      the response after the deactivation attempt

    • deleteMediaSession

      MediaSessionUpsertResponse deleteMediaSession(String id, MediaSessionActionRequest req)
      Deletes a media session.
      Parameters:
      id - the session ID to delete
      req - the action request (reason should be "delete")
      Returns:
      the response after the deletion attempt

    • getMediaSessionStatus

      com.oracle.sdp.mgs.api.model.MediaSessionStatusResult getMediaSessionStatus(String id)
      Retrieves the current status of a media session.
      Parameters:
      id - media session identifier
      Returns:
      MediaSessionStatusResult containing either MediaSession data or ErrorResponse